Package com.oracle.bmc.apigateway

Interface DeploymentAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DeploymentAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface DeploymentAsync
extends AutoCloseable
    API for the API Gateway service.

    Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • addDeploymentLock

        Future<AddDeploymentLockResponse> addDeploymentLock​(AddDeploymentLockRequest request,
                                                    AsyncHandler<AddDeploymentLockRequest,​AddDeploymentLockResponse> handler)
        Adds a lock to a Deployment resource.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createDeployment

        Future<CreateDeploymentResponse> createDeployment​(CreateDeploymentRequest request,
                                                  AsyncHandler<CreateDeploymentRequest,​CreateDeploymentResponse> handler)
        Creates a new deployment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteDeployment

        Future<DeleteDeploymentResponse> deleteDeployment​(DeleteDeploymentRequest request,
                                                  AsyncHandler<DeleteDeploymentRequest,​DeleteDeploymentResponse> handler)
        Deletes the deployment with the given identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDeployment

        Future<GetDeploymentResponse> getDeployment​(GetDeploymentRequest request,
                                            AsyncHandler<GetDeploymentRequest,​GetDeploymentResponse> handler)
        Gets a deployment by identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDeployments

        Future<ListDeploymentsResponse> listDeployments​(ListDeploymentsRequest request,
                                                AsyncHandler<ListDeploymentsRequest,​ListDeploymentsResponse> handler)
        Returns a list of deployments.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • removeDeploymentLock

        Future<RemoveDeploymentLockResponse> removeDeploymentLock​(RemoveDeploymentLockRequest request,
                                                          AsyncHandler<RemoveDeploymentLockRequest,​RemoveDeploymentLockResponse> handler)
        Removes a lock from a Deployment resource.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDeployment

        Future<UpdateDeploymentResponse> updateDeployment​(UpdateDeploymentRequest request,
                                                  AsyncHandler<UpdateDeploymentRequest,​UpdateDeploymentResponse> handler)
        Updates the deployment with the given identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.