Package com.ibm.cloud.networking.cis_ip_api.v1

Class CisIpApi

  • public class CisIpApi
extends com.ibm.cloud.sdk.core.service.BaseService
    This document describes CIS IP API.
    Version:
    v1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String DEFAULT_SERVICE_NAME  
      static String DEFAULT_SERVICE_URL  

      • Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

        PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

    • Constructor Summary

      Constructors 
      Constructor Description
      CisIpApi​(String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
      Constructs an instance of the `CisIpApi` client.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.ibm.cloud.sdk.core.http.ServiceCall<IpResponse> listIps()
      List of all IP addresses used by the CIS proxy.
      com.ibm.cloud.sdk.core.http.ServiceCall<IpResponse> listIps​(ListIpsOptions listIpsOptions)
      List of all IP addresses used by the CIS proxy.
      static CisIpApi newInstance()
      Class method which constructs an instance of the `CisIpApi` client.
      static CisIpApi newInstance​(String serviceName)
      Class method which constructs an instance of the `CisIpApi` client.

      • Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

        configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

    • Constructor Detail

      • CisIpApi

        public CisIpApi​(String serviceName,
                com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CisIpApi` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static CisIpApi newInstance()
        Class method which constructs an instance of the `CisIpApi` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `CisIpApi` client using external configuration

      • newInstance

        public static CisIpApi newInstance​(String serviceName)
        Class method which constructs an instance of the `CisIpApi` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `CisIpApi` client using external configuration

      • listIps

        public com.ibm.cloud.sdk.core.http.ServiceCall<IpResponse> listIps​(ListIpsOptions listIpsOptions)
        List of all IP addresses used by the CIS proxy. List of all IP addresses used by the CIS proxy.
        Parameters:
        listIpsOptions - the ListIpsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type IpResponse

      • listIps

        public com.ibm.cloud.sdk.core.http.ServiceCall<IpResponse> listIps()
        List of all IP addresses used by the CIS proxy. List of all IP addresses used by the CIS proxy.
        Returns:
        a ServiceCall with a result of type IpResponse