Package com.ibm.cloud.networking.direct_link_provider.v2

Class DirectLinkProvider

  • public class DirectLinkProvider
extends com.ibm.cloud.sdk.core.service.BaseService
    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator). API Version: __VERSION__

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `DirectLinkProvider` client.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DirectLinkProvider

        public DirectLinkProvider​(String version,
                          String serviceName,
                          com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `DirectLinkProvider` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        version - Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2020-04-28 up to the current date may be provided. Specify the current date to request the latest version.
        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 DirectLinkProvider newInstance​(String version)
        Class method which constructs an instance of the `DirectLinkProvider` client. The default service name is used to configure the client instance.
        Parameters:
        version - Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2020-04-28 up to the current date may be provided. Specify the current date to request the latest version.
        Returns:
        an instance of the `DirectLinkProvider` client using external configuration

      • newInstance

        public static DirectLinkProvider newInstance​(String version,
                                             String serviceName)
        Class method which constructs an instance of the `DirectLinkProvider` client. The specified service name is used to configure the client instance.
        Parameters:
        version - Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2020-04-28 up to the current date may be provided. Specify the current date to request the latest version.
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `DirectLinkProvider` client using external configuration

      • getVersion

        public String getVersion()
        Gets the version. Requests the version of the API as a date in the format `YYYY-MM-DD`. Any date from 2020-04-28 up to the current date may be provided. Specify the current date to request the latest version.
        Returns:
        the version

      • setVersion

        public void setVersion​(String version)
        Sets the version.
        Parameters:
        version - the new version

      • listProviderGateways

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderGatewayCollection> listProviderGateways()
        List gateways. List all Direct Link Connect gateways created by this provider.
        Returns:
        a ServiceCall with a result of type ProviderGatewayCollection

      • createProviderGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderGateway> createProviderGateway​(CreateProviderGatewayOptions createProviderGatewayOptions)
        Create gateway. Create a Direct Link Connect gateway based on the supplied template in the specified customer account. The gateway will be 'provider_api_managed=true'.
        Parameters:
        createProviderGatewayOptions - the CreateProviderGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderGateway

      • getProviderGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderGateway> getProviderGateway​(GetProviderGatewayOptions getProviderGatewayOptions)
        Get gateway. Get a Direct Link Connect gateway. Gateways with either `provider_api_managed=true` or `provider_api_managed=false` can be retrieved.
        Parameters:
        getProviderGatewayOptions - the GetProviderGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderGateway

      • updateProviderGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderGateway> updateProviderGateway​(UpdateProviderGatewayOptions updateProviderGatewayOptions)
        Update gateway. Update a Direct Link Connect provider managed gateway. Name changes are applied immediately, other changes result in a gateway change_request and require approval from the client.
        Parameters:
        updateProviderGatewayOptions - the UpdateProviderGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderGateway

      • listProviderPorts

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderPortCollection> listProviderPorts()
        List ports. List all provider ports (associated with the caller).
        Returns:
        a ServiceCall with a result of type ProviderPortCollection

      • getProviderPort

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderPort> getProviderPort​(GetProviderPortOptions getProviderPortOptions)
        Get port. Get provider port information.
        Parameters:
        getProviderPortOptions - the GetProviderPortOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderPort