Package com.ibm.cloud.networking.transit_gateway_apis.v1

Class TransitGatewayApis

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

    • Constructor Detail

      • TransitGatewayApis

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

      • newInstance

        public static TransitGatewayApis newInstance​(String version,
                                             String serviceName)
        Class method which constructs an instance of the `TransitGatewayApis` client. The specified service name is used to configure the client instance.
        Parameters:
        version - Requests the version of the API as of a date in the format `YYYY-MM-DD`. Any date 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 `TransitGatewayApis` client using external configuration

      • getVersion

        public String getVersion()
        Gets the version. Requests the version of the API as of a date in the format `YYYY-MM-DD`. Any date 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

      • listTransitGateways

        public com.ibm.cloud.sdk.core.http.ServiceCall<TransitGatewayCollection> listTransitGateways()
        Retrieves all Transit Gateways. List all Transit Gateways in account the caller is authorized to view.
        Returns:
        a ServiceCall with a result of type TransitGatewayCollection

      • createTransitGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<TransitGateway> createTransitGateway​(CreateTransitGatewayOptions createTransitGatewayOptions)
        Creates a Transit Gateway. Create a Transit Gateway based on the supplied input template.
        Parameters:
        createTransitGatewayOptions - the CreateTransitGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TransitGateway

      • deleteTransitGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTransitGateway​(DeleteTransitGatewayOptions deleteTransitGatewayOptions)
        Deletes specified Transit Gateway. This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
        Parameters:
        deleteTransitGatewayOptions - the DeleteTransitGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getTransitGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<TransitGateway> getTransitGateway​(GetTransitGatewayOptions getTransitGatewayOptions)
        Retrieves specified Transit Gateway. This request retrieves a single Transit Gateway specified by the identifier in the URL.
        Parameters:
        getTransitGatewayOptions - the GetTransitGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TransitGateway

      • updateTransitGateway

        public com.ibm.cloud.sdk.core.http.ServiceCall<TransitGateway> updateTransitGateway​(UpdateTransitGatewayOptions updateTransitGatewayOptions)
        Updates specified Transit Gateway. This request updates a Transit Gateway's name and/or global flag.
        Parameters:
        updateTransitGatewayOptions - the UpdateTransitGatewayOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TransitGateway

      • listConnections

        public com.ibm.cloud.sdk.core.http.ServiceCall<TransitConnectionCollection> listConnections()
        Retrieves all connections. List all transit gateway connections associated with this account.
        Returns:
        a ServiceCall with a result of type TransitConnectionCollection

      • deleteTransitGatewayConnection

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTransitGatewayConnection​(DeleteTransitGatewayConnectionOptions deleteTransitGatewayConnectionOptions)
        Remove connection from Transit Gateway. After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
        Parameters:
        deleteTransitGatewayConnectionOptions - the DeleteTransitGatewayConnectionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createTransitGatewayConnectionActions

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> createTransitGatewayConnectionActions​(CreateTransitGatewayConnectionActionsOptions createTransitGatewayConnectionActionsOptions)
        Perform actions on a connection for a Transit Gateway. Allow a network owner to approve or reject a cross-account connection request.
        Parameters:
        createTransitGatewayConnectionActionsOptions - the CreateTransitGatewayConnectionActionsOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteTransitGatewayConnectionTunnels

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTransitGatewayConnectionTunnels​(DeleteTransitGatewayConnectionTunnelsOptions deleteTransitGatewayConnectionTunnelsOptions)
        Delete specified Transit Gateway redundant GRE tunnel. Remove a tunnel from a redundant GRE connection.
        Parameters:
        deleteTransitGatewayConnectionTunnelsOptions - the DeleteTransitGatewayConnectionTunnelsOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listGatewayLocations

        public com.ibm.cloud.sdk.core.http.ServiceCall<TSCollection> listGatewayLocations​(ListGatewayLocationsOptions listGatewayLocationsOptions)
        List all locations that support Transit Gateways. List all locations that support Transit Gateways.
        Parameters:
        listGatewayLocationsOptions - the ListGatewayLocationsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TSCollection

      • listGatewayLocations

        public com.ibm.cloud.sdk.core.http.ServiceCall<TSCollection> listGatewayLocations()
        List all locations that support Transit Gateways. List all locations that support Transit Gateways.
        Returns:
        a ServiceCall with a result of type TSCollection

      • getGatewayLocation

        public com.ibm.cloud.sdk.core.http.ServiceCall<TSLocation> getGatewayLocation​(GetGatewayLocationOptions getGatewayLocationOptions)
        Show the details of a given Transit Gateway location. Get the details of a Transit Gateway Location.
        Parameters:
        getGatewayLocationOptions - the GetGatewayLocationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TSLocation

      • deleteTransitGatewayConnectionPrefixFilter

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTransitGatewayConnectionPrefixFilter​(DeleteTransitGatewayConnectionPrefixFilterOptions deleteTransitGatewayConnectionPrefixFilterOptions)
        Remove prefix filter from Transit Gateway Connection. Delete a prefix filter.
        Parameters:
        deleteTransitGatewayConnectionPrefixFilterOptions - the DeleteTransitGatewayConnectionPrefixFilterOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listTransitGatewayRouteReports

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteReportCollection> listTransitGatewayRouteReports​(ListTransitGatewayRouteReportsOptions listTransitGatewayRouteReportsOptions)
        List route reports. Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
        Parameters:
        listTransitGatewayRouteReportsOptions - the ListTransitGatewayRouteReportsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteReportCollection

      • createTransitGatewayRouteReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<RouteReport> createTransitGatewayRouteReport​(CreateTransitGatewayRouteReportOptions createTransitGatewayRouteReportOptions)
        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.
        Parameters:
        createTransitGatewayRouteReportOptions - the CreateTransitGatewayRouteReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type RouteReport

      • deleteTransitGatewayRouteReport

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