Package com.ibm.cloud.networking.direct_link.v1

Class DirectLink

  • public class DirectLink
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 `DirectLink` client.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DirectLink

        public DirectLink​(String version,
                  String serviceName,
                  com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `DirectLink` 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 2019-12-13 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 DirectLink newInstance​(String version)
        Class method which constructs an instance of the `DirectLink` 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 2019-12-13 up to the current date may be provided. Specify the current date to request the latest version.
        Returns:
        an instance of the `DirectLink` client using external configuration

      • newInstance

        public static DirectLink newInstance​(String version,
                                     String serviceName)
        Class method which constructs an instance of the `DirectLink` 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 2019-12-13 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 `DirectLink` 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 2019-12-13 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

      • listGateways

        public com.ibm.cloud.sdk.core.http.ServiceCall<GatewayCollection> listGateways​(ListGatewaysOptions listGatewaysOptions)
        List gateways. List all Direct Link gateways in this account. Gateways in other accounts with connections to networks in this account are also returned.
        Parameters:
        listGatewaysOptions - the ListGatewaysOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type GatewayCollection

      • listGateways

        public com.ibm.cloud.sdk.core.http.ServiceCall<GatewayCollection> listGateways()
        List gateways. List all Direct Link gateways in this account. Gateways in other accounts with connections to networks in this account are also returned.
        Returns:
        a ServiceCall with a result of type GatewayCollection

      • createGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<Gateway> createGateway​(CreateGatewayOptions createGatewayOptions)
        Create gateway. Creates a Direct Link gateway based on the supplied template.
        Parameters:
        createGatewayOptions - the CreateGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Gateway

      • deleteGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteGateway​(DeleteGatewayOptions deleteGatewayOptions)
        Delete gateway. Delete a Direct Link gateway.
        Parameters:
        deleteGatewayOptions - the DeleteGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<Gateway> getGateway​(GetGatewayOptions getGatewayOptions)
        Get gateway. Retrieve a Direct Link gateway.
        Parameters:
        getGatewayOptions - the GetGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Gateway

      • updateGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<Gateway> updateGateway​(UpdateGatewayOptions updateGatewayOptions)
        Update gateway. Update a Direct Link gateway.
        Parameters:
        updateGatewayOptions - the UpdateGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Gateway

      • createGatewayAction

        public com.ibm.cloud.sdk.core.http.ServiceCall<Gateway> createGatewayAction​(CreateGatewayActionOptions createGatewayActionOptions)
        Approve or reject change requests. Approve or reject a gateway's current oustanding change request. This API is only used for provider created Direct Link Connect gateways to approve or reject specific changes initiated from a provider portal.
        Parameters:
        createGatewayActionOptions - the CreateGatewayActionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Gateway

      • listGatewayCompletionNotice

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> listGatewayCompletionNotice​(ListGatewayCompletionNoticeOptions listGatewayCompletionNoticeOptions)
        Get completion notice. Retrieve a Direct Link Dedicated gateway's completion notice.
        Parameters:
        listGatewayCompletionNoticeOptions - the ListGatewayCompletionNoticeOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • createGatewayCompletionNotice

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> createGatewayCompletionNotice​(CreateGatewayCompletionNoticeOptions createGatewayCompletionNoticeOptions)
        Create completion notice. Upload a Direct Link Dedicated gateway completion notice.
        Parameters:
        createGatewayCompletionNoticeOptions - the CreateGatewayCompletionNoticeOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listGatewayLetterOfAuthorization

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> listGatewayLetterOfAuthorization​(ListGatewayLetterOfAuthorizationOptions listGatewayLetterOfAuthorizationOptions)
        Get letter of authorization. Retrieve a Direct Link Dedicated gateway's Letter of Authorization.
        Parameters:
        listGatewayLetterOfAuthorizationOptions - the ListGatewayLetterOfAuthorizationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • listGatewayExportRouteFilters

        public com.ibm.cloud.sdk.core.http.ServiceCall<ExportRouteFilterCollection> listGatewayExportRouteFilters​(ListGatewayExportRouteFiltersOptions listGatewayExportRouteFiltersOptions)
        List export route filters. List all export route filters that influence the export routes advertised to the on premises network and learned from attached virtual connections of the Direct Link gateway. The first export route filter an export route matches will determine whether the route is permitted or denied to be advertised by the Direct Link gateway. Route filter order is determined by the filter's `before` field. If an export route does not match any of the export route filters, the route is subject to the `default_export_route_filter` of the direct link.
        Parameters:
        listGatewayExportRouteFiltersOptions - the ListGatewayExportRouteFiltersOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ExportRouteFilterCollection

      • createGatewayExportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> createGatewayExportRouteFilter​(CreateGatewayExportRouteFilterOptions createGatewayExportRouteFilterOptions)
        Create an export route filter. Create a new export route filter to be configured on the Direct Link gateway. This call can result in an implicit update to another route filter's `before` field. If the request's route filter template does not contain a `before` field, the created filter will be added to the end of of the list. The filter previously at the end of the list will have it's `before` field set to the created route filter. If the request's route filter template contains a `before` field, the created filter will be added directly before that specified route filter. If the specified route filter has a preceding route filter, that filter's `before` field is updated to the created route filter.
        Parameters:
        createGatewayExportRouteFilterOptions - the CreateGatewayExportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • deleteGatewayExportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteGatewayExportRouteFilter​(DeleteGatewayExportRouteFilterOptions deleteGatewayExportRouteFilterOptions)
        Remove export route filter from Direct Link gateway. Delete an export route filter. Deleting an export route filter will implicitly update the preceding filter's `before` field to the filter that follows the deleted filter. The preceding filter will result with an empty `before` field if there is no filter following the deleted route filter.
        Parameters:
        deleteGatewayExportRouteFilterOptions - the DeleteGatewayExportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getGatewayExportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> getGatewayExportRouteFilter​(GetGatewayExportRouteFilterOptions getGatewayExportRouteFilterOptions)
        Retrieves the specified Direct Link gateway export route filter. Retrieve an export route filter from the Direct Link gateway.
        Parameters:
        getGatewayExportRouteFilterOptions - the GetGatewayExportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • updateGatewayExportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> updateGatewayExportRouteFilter​(UpdateGatewayExportRouteFilterOptions updateGatewayExportRouteFilterOptions)
        Updates the specified Direct Link gateway export route filter. Update an export route filter from the Direct Link gateway. Updating a route filter's `before` field will result in implicit updates to other route filters' `before` fields. Considering the updated filter prior to the update, the preceding route filter's `before` field will be set to the filter following the updating route filter, if present. Otherwise it is set to empty. Considering the updated filter after the update, if the new filter following the updated filter has an existing filter preceding it, that preceding filter's `before` field will be set to the updated filter.
        Parameters:
        updateGatewayExportRouteFilterOptions - the UpdateGatewayExportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • listGatewayImportRouteFilters

        public com.ibm.cloud.sdk.core.http.ServiceCall<ImportRouteFilterCollection> listGatewayImportRouteFilters​(ListGatewayImportRouteFiltersOptions listGatewayImportRouteFiltersOptions)
        List import route filters. List all import route filters that influence the import routes learned from the on premises network. The first import route filter an import route matches will determine whether the route is permitted or denied to be learned by the Direct Link gateway. Route filter order is determined by the filter's `before` field. If an import route does not match any of the import route filters, the route is subject to the `default_import_route_filter` of the direct link.
        Parameters:
        listGatewayImportRouteFiltersOptions - the ListGatewayImportRouteFiltersOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ImportRouteFilterCollection

      • createGatewayImportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> createGatewayImportRouteFilter​(CreateGatewayImportRouteFilterOptions createGatewayImportRouteFilterOptions)
        Create an import route filter. Create a new import route filter to be configured on the Direct Link gateway. This call can result in an implicit update to another route filter's `before` field. If the request's route filter template does not contain a `before` field, the created filter will be added to the end of of the list. The filter previously at the end of the list will have it's `before` field set to the created route filter. If the request's route filter template contains a `before` field, the created filter will be added directly before that specified route filter. If the specified route filter has a preceding route filter, that filter's `before` field is updated to the created route filter.
        Parameters:
        createGatewayImportRouteFilterOptions - the CreateGatewayImportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • deleteGatewayImportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteGatewayImportRouteFilter​(DeleteGatewayImportRouteFilterOptions deleteGatewayImportRouteFilterOptions)
        Remove import route filter from Direct Link gateway. Delete an import route filter. Deleting an import route filter will implicitly update the preceding filter's `before` field to the filter that follows the deleted filter. The preceding filter will result with an empty `before` field if there is no filter following the deleted route filter.
        Parameters:
        deleteGatewayImportRouteFilterOptions - the DeleteGatewayImportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getGatewayImportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> getGatewayImportRouteFilter​(GetGatewayImportRouteFilterOptions getGatewayImportRouteFilterOptions)
        Retrieves the specified Direct Link gateway import route filter. Retrieve an import route filter from the Direct Link gateway.
        Parameters:
        getGatewayImportRouteFilterOptions - the GetGatewayImportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • updateGatewayImportRouteFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteFilter> updateGatewayImportRouteFilter​(UpdateGatewayImportRouteFilterOptions updateGatewayImportRouteFilterOptions)
        Updates the specified Direct Link gateway import route filter. Update an import route filter from the Direct Link gateway. Updating a route filter's `before` field will result in implicit updates to other route filters' `before` fields. Considering the updated filter prior to the update, the preceding route filter's `before` field will be set to the filter following the updating route filter, if present. Otherwise it is set to empty. Considering the updated filter after the update, if the new filter following the updated filter has an existing filter preceding it, that preceding filter's `before` field will be set to the updated filter.
        Parameters:
        updateGatewayImportRouteFilterOptions - the UpdateGatewayImportRouteFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteFilter

      • createGatewayRouteReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteReport> createGatewayRouteReport​(CreateGatewayRouteReportOptions createGatewayRouteReportOptions)
        Request a route report. Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report. While `status` is `pending`, `gateway_routes`, `on_prem_routes`, `virtual_connection_routes`, and `overlapping_routes` will be empty arrays. These fields will be filled when the `status` enters the `complete` status. Call `get_gateway_route_report` with the pending route report's `id` to check on the current status of the report.
        Parameters:
        createGatewayRouteReportOptions - the CreateGatewayRouteReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteReport

      • deleteGatewayRouteReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteGatewayRouteReport​(DeleteGatewayRouteReportOptions deleteGatewayRouteReportOptions)
        Delete route report. Delete a route report.
        Parameters:
        deleteGatewayRouteReportOptions - the DeleteGatewayRouteReportOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteGatewayVirtualConnection

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteGatewayVirtualConnection​(DeleteGatewayVirtualConnectionOptions deleteGatewayVirtualConnectionOptions)
        Delete virtual connection. Delete the virtual connection.
        Parameters:
        deleteGatewayVirtualConnectionOptions - the DeleteGatewayVirtualConnectionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listPorts

        public com.ibm.cloud.sdk.core.http.ServiceCall<PortCollection> listPorts​(ListPortsOptions listPortsOptions)
        List ports. Retrieve list of available Direct Link connect ports. These ports can be used to create Direct Link connect gateways.
        Parameters:
        listPortsOptions - the ListPortsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PortCollection

      • listPorts

        public com.ibm.cloud.sdk.core.http.ServiceCall<PortCollection> listPorts()
        List ports. Retrieve list of available Direct Link connect ports. These ports can be used to create Direct Link connect gateways.
        Returns:
        a ServiceCall with a result of type PortCollection

      • getPort

        public com.ibm.cloud.sdk.core.http.ServiceCall<Port> getPort​(GetPortOptions getPortOptions)
        Get port. Retrieve Direct Link Connect provider port.
        Parameters:
        getPortOptions - the GetPortOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Port

      • replaceGatewayAsPrepends

        public com.ibm.cloud.sdk.core.http.ServiceCall<AsPrependCollection> replaceGatewayAsPrepends​(ReplaceGatewayAsPrependsOptions replaceGatewayAsPrependsOptions)
        Replace existing AS Prepends. Replace the given set of AS prepends on the specified gateway. Existing resources may be reused when the individual AS Prepend item is unchanged.
        Parameters:
        replaceGatewayAsPrependsOptions - the ReplaceGatewayAsPrependsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AsPrependCollection