Interface BlueGreenDeploymentsAsync

    • 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
      • changeBlueGreenDeploymentCompartment

        Future<ChangeBlueGreenDeploymentCompartmentResponse> changeBlueGreenDeploymentCompartment​(ChangeBlueGreenDeploymentCompartmentRequest request,
                                                                                                  AsyncHandler<ChangeBlueGreenDeploymentCompartmentRequest,​ChangeBlueGreenDeploymentCompartmentResponse> handler)
        Moves only the blue/green deployment wrapper resource into a different compartment.

        This operation does not move the source DB system, target DB system, or replication channel referenced by the deployment. When provided, If-Match is checked against ETag values of the blue/green 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.
      • deleteBlueGreenDeployment

        Future<DeleteBlueGreenDeploymentResponse> deleteBlueGreenDeployment​(DeleteBlueGreenDeploymentRequest request,
                                                                            AsyncHandler<DeleteBlueGreenDeploymentRequest,​DeleteBlueGreenDeploymentResponse> handler)
        Deletes only the blue/green deployment wrapper resource.

        This operation does not delete the source DB system, target DB system, or replication channel associated with the 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.
      • getBlueGreenDeployment

        Future<GetBlueGreenDeploymentResponse> getBlueGreenDeployment​(GetBlueGreenDeploymentRequest request,
                                                                      AsyncHandler<GetBlueGreenDeploymentRequest,​GetBlueGreenDeploymentResponse> handler)
        Gets a blue/green 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.
      • switchoverBlueGreenDeployment

        Future<SwitchoverBlueGreenDeploymentResponse> switchoverBlueGreenDeployment​(SwitchoverBlueGreenDeploymentRequest request,
                                                                                    AsyncHandler<SwitchoverBlueGreenDeploymentRequest,​SwitchoverBlueGreenDeploymentResponse> handler)
        Initiates switchover for a blue/green deployment.

        This action is asynchronous and supports idempotent retry only when the same `opc-retry-token` is reused for an equivalent switchover request on the same blue/green deployment. Equivalent request identity includes materially equivalent request parameters after applying defaults and preconditions, including the effective `waitTimeInSeconds` from the request body and the same `If-Match` value when provided. An empty switchover details body and a body that explicitly passes the default `waitTimeInSeconds=300` are equivalent.

        Requests that change `If-Match` or other material preconditions are treated as new requests and follow normal conflict (`409`) or precondition (`412`) handling instead of ordinary retry reuse.

        Switchover outcome and partial/failure conditions are surfaced through `lifecycleState`, `lifecycleDetails`, `switchoverStatus`, and `activeDbSystemId` in the blue/green deployment resource.

        When `waitTimeInSeconds` is omitted from the request body, the default wait time applies. The effective wait time provides upper bound guidance for waiting while the target DB System applies remaining replication changes during switchover processing.

        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.
      • updateBlueGreenDeployment

        Future<UpdateBlueGreenDeploymentResponse> updateBlueGreenDeployment​(UpdateBlueGreenDeploymentRequest request,
                                                                            AsyncHandler<UpdateBlueGreenDeploymentRequest,​UpdateBlueGreenDeploymentResponse> handler)
        Updates mutable metadata for a blue/green deployment.

        Currently only displayName, freeformTags, and definedTags can be changed.

        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.