Interface GoldenGateAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    GoldenGateAsyncClient

    @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public interface GoldenGateAsync
    extends AutoCloseable
    Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.
    • 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
      • addConnectionLock

        Future<AddConnectionLockResponse> addConnectionLock​(AddConnectionLockRequest request,
                                                            AsyncHandler<AddConnectionLockRequest,​AddConnectionLockResponse> handler)
        Adds a lock to a Connection 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.
      • addDeploymentBackupLock

        Future<AddDeploymentBackupLockResponse> addDeploymentBackupLock​(AddDeploymentBackupLockRequest request,
                                                                        AsyncHandler<AddDeploymentBackupLockRequest,​AddDeploymentBackupLockResponse> handler)
        Adds a lock to a DeploymentBackup 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.
      • addDeploymentLocalPeer

        Future<AddDeploymentLocalPeerResponse> addDeploymentLocalPeer​(AddDeploymentLocalPeerRequest request,
                                                                      AsyncHandler<AddDeploymentLocalPeerRequest,​AddDeploymentLocalPeerResponse> handler)
        Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute.

        When provided, If-Match is checked against ETag values of the 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.
      • 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.
      • cancelDeploymentBackup

        Future<CancelDeploymentBackupResponse> cancelDeploymentBackup​(CancelDeploymentBackupRequest request,
                                                                      AsyncHandler<CancelDeploymentBackupRequest,​CancelDeploymentBackupResponse> handler)
        Cancels a Deployment Backup creation process.
        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.
      • cancelDeploymentUpgrade

        Future<CancelDeploymentUpgradeResponse> cancelDeploymentUpgrade​(CancelDeploymentUpgradeRequest request,
                                                                        AsyncHandler<CancelDeploymentUpgradeRequest,​CancelDeploymentUpgradeResponse> handler)
        Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.

        When provided, If-Match is checked against ETag values of the 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.
      • collectDeploymentDiagnostic

        Future<CollectDeploymentDiagnosticResponse> collectDeploymentDiagnostic​(CollectDeploymentDiagnosticRequest request,
                                                                                AsyncHandler<CollectDeploymentDiagnosticRequest,​CollectDeploymentDiagnosticResponse> handler)
        Collects the diagnostic of a Deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • copyDeploymentBackup

        Future<CopyDeploymentBackupResponse> copyDeploymentBackup​(CopyDeploymentBackupRequest request,
                                                                  AsyncHandler<CopyDeploymentBackupRequest,​CopyDeploymentBackupResponse> handler)
        Creates a copy of a Deployment Backup.
        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.
      • createCertificate

        Future<CreateCertificateResponse> createCertificate​(CreateCertificateRequest request,
                                                            AsyncHandler<CreateCertificateRequest,​CreateCertificateResponse> handler)
        Creates a new certificate to truststore.
        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.
      • createConnection

        Future<CreateConnectionResponse> createConnection​(CreateConnectionRequest request,
                                                          AsyncHandler<CreateConnectionRequest,​CreateConnectionResponse> handler)
        Creates a new Connection.
        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.
      • createDatabaseRegistration

        Future<CreateDatabaseRegistrationResponse> createDatabaseRegistration​(CreateDatabaseRegistrationRequest request,
                                                                              AsyncHandler<CreateDatabaseRegistrationRequest,​CreateDatabaseRegistrationResponse> handler)
        Note: Deprecated.

        Use the /connections API instead. Creates a new DatabaseRegistration.

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

        Future<CreateDeploymentBackupResponse> createDeploymentBackup​(CreateDeploymentBackupRequest request,
                                                                      AsyncHandler<CreateDeploymentBackupRequest,​CreateDeploymentBackupResponse> handler)
        Creates a new DeploymentBackup.
        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.
      • createPipeline

        Future<CreatePipelineResponse> createPipeline​(CreatePipelineRequest request,
                                                      AsyncHandler<CreatePipelineRequest,​CreatePipelineResponse> handler)
        Creates a new Pipeline.
        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.
      • deleteCertificate

        Future<DeleteCertificateResponse> deleteCertificate​(DeleteCertificateRequest request,
                                                            AsyncHandler<DeleteCertificateRequest,​DeleteCertificateResponse> handler)
        Deletes the certificate from truststore.
        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.
      • deleteConnection

        Future<DeleteConnectionResponse> deleteConnection​(DeleteConnectionRequest request,
                                                          AsyncHandler<DeleteConnectionRequest,​DeleteConnectionResponse> handler)
        Deletes a Connection.
        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.
        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.
      • deletePipeline

        Future<DeletePipelineResponse> deletePipeline​(DeletePipelineRequest request,
                                                      AsyncHandler<DeletePipelineRequest,​DeletePipelineResponse> handler)
        Deletes a Pipeline.
        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.
      • deploymentWalletExists

        Future<DeploymentWalletExistsResponse> deploymentWalletExists​(DeploymentWalletExistsRequest request,
                                                                      AsyncHandler<DeploymentWalletExistsRequest,​DeploymentWalletExistsResponse> handler)
        Checks if a wallet is already present in the deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • exportDeploymentWallet

        Future<ExportDeploymentWalletResponse> exportDeploymentWallet​(ExportDeploymentWalletRequest request,
                                                                      AsyncHandler<ExportDeploymentWalletRequest,​ExportDeploymentWalletResponse> handler)
        Export the OGG wallet from the deployment to OCI vault.

        When provided, If-Match is checked against ETag values of the 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.
      • generateLibraryUrl

        Future<GenerateLibraryUrlResponse> generateLibraryUrl​(GenerateLibraryUrlRequest request,
                                                              AsyncHandler<GenerateLibraryUrlRequest,​GenerateLibraryUrlResponse> handler)
        Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it.

        For licensing reasons, the URL is accessible for 10 minutes only.

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

        Future<GetCertificateResponse> getCertificate​(GetCertificateRequest request,
                                                      AsyncHandler<GetCertificateRequest,​GetCertificateResponse> handler)
        Retrieves a Certificate.
        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.
      • getConnection

        Future<GetConnectionResponse> getConnection​(GetConnectionRequest request,
                                                    AsyncHandler<GetConnectionRequest,​GetConnectionResponse> handler)
        Retrieves a Connection.
        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.
      • getDatabaseRegistration

        Future<GetDatabaseRegistrationResponse> getDatabaseRegistration​(GetDatabaseRegistrationRequest request,
                                                                        AsyncHandler<GetDatabaseRegistrationRequest,​GetDatabaseRegistrationResponse> handler)
        Note: Deprecated.

        Use the /connections API instead. Retrieves a DatabaseRegistration.

        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)
        Retrieves a 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.
      • getDeploymentBackup

        Future<GetDeploymentBackupResponse> getDeploymentBackup​(GetDeploymentBackupRequest request,
                                                                AsyncHandler<GetDeploymentBackupRequest,​GetDeploymentBackupResponse> handler)
        Retrieves a DeploymentBackup.
        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.
      • getDeploymentUpgrade

        Future<GetDeploymentUpgradeResponse> getDeploymentUpgrade​(GetDeploymentUpgradeRequest request,
                                                                  AsyncHandler<GetDeploymentUpgradeRequest,​GetDeploymentUpgradeResponse> handler)
        Retrieves a deployment upgrade.
        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.
      • getPipeline

        Future<GetPipelineResponse> getPipeline​(GetPipelineRequest request,
                                                AsyncHandler<GetPipelineRequest,​GetPipelineResponse> handler)
        Retrieves a Pipeline details.
        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.
      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                                      AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Retrieve the WorkRequest identified by the given OCID.
        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.
      • importDeploymentWallet

        Future<ImportDeploymentWalletResponse> importDeploymentWallet​(ImportDeploymentWalletRequest request,
                                                                      AsyncHandler<ImportDeploymentWalletRequest,​ImportDeploymentWalletResponse> handler)
        Imports an OGG wallet from the OCI Vault to the Deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • listCertificates

        Future<ListCertificatesResponse> listCertificates​(ListCertificatesRequest request,
                                                          AsyncHandler<ListCertificatesRequest,​ListCertificatesResponse> handler)
        Returns a list of certificates from truststore.
        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.
      • listConnections

        Future<ListConnectionsResponse> listConnections​(ListConnectionsRequest request,
                                                        AsyncHandler<ListConnectionsRequest,​ListConnectionsResponse> handler)
        Lists the Connections in the compartment.
        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.
      • listDatabaseRegistrations

        Future<ListDatabaseRegistrationsResponse> listDatabaseRegistrations​(ListDatabaseRegistrationsRequest request,
                                                                            AsyncHandler<ListDatabaseRegistrationsRequest,​ListDatabaseRegistrationsResponse> handler)
        Note: Deprecated.

        Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.

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

        Future<ListDeploymentBackupsResponse> listDeploymentBackups​(ListDeploymentBackupsRequest request,
                                                                    AsyncHandler<ListDeploymentBackupsRequest,​ListDeploymentBackupsResponse> handler)
        Lists the Backups in a compartment.
        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.
      • listDeploymentPeers

        Future<ListDeploymentPeersResponse> listDeploymentPeers​(ListDeploymentPeersRequest request,
                                                                AsyncHandler<ListDeploymentPeersRequest,​ListDeploymentPeersResponse> handler)
        Lists the local and remote peers in a 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.
      • listDeploymentTypes

        Future<ListDeploymentTypesResponse> listDeploymentTypes​(ListDeploymentTypesRequest request,
                                                                AsyncHandler<ListDeploymentTypesRequest,​ListDeploymentTypesResponse> handler)
        Returns an array of DeploymentTypeDescriptor
        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.
      • listDeploymentUpgrades

        Future<ListDeploymentUpgradesResponse> listDeploymentUpgrades​(ListDeploymentUpgradesRequest request,
                                                                      AsyncHandler<ListDeploymentUpgradesRequest,​ListDeploymentUpgradesResponse> handler)
        Lists the Deployment Upgrades in a compartment.
        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.
      • listDeploymentVersions

        Future<ListDeploymentVersionsResponse> listDeploymentVersions​(ListDeploymentVersionsRequest request,
                                                                      AsyncHandler<ListDeploymentVersionsRequest,​ListDeploymentVersionsResponse> handler)
        Returns the list of available deployment versions.
        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)
        Lists the Deployments in a compartment.
        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.
      • listMessages

        Future<ListMessagesResponse> listMessages​(ListMessagesRequest request,
                                                  AsyncHandler<ListMessagesRequest,​ListMessagesResponse> handler)
        Lists the DeploymentMessages for a deployment.

        The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.

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

        Future<ListPipelineSchemaTablesResponse> listPipelineSchemaTables​(ListPipelineSchemaTablesRequest request,
                                                                          AsyncHandler<ListPipelineSchemaTablesRequest,​ListPipelineSchemaTablesResponse> handler)
        Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.
        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.
      • listPipelineSchemas

        Future<ListPipelineSchemasResponse> listPipelineSchemas​(ListPipelineSchemasRequest request,
                                                                AsyncHandler<ListPipelineSchemasRequest,​ListPipelineSchemasResponse> handler)
        Returns an array of schemas based on mapping rules for a pipeline.
        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.
      • listPipelines

        Future<ListPipelinesResponse> listPipelines​(ListPipelinesRequest request,
                                                    AsyncHandler<ListPipelinesRequest,​ListPipelinesResponse> handler)
        Lists the Pipelines in the compartment.
        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.
      • listRecipes

        Future<ListRecipesResponse> listRecipes​(ListRecipesRequest request,
                                                AsyncHandler<ListRecipesRequest,​ListRecipesResponse> handler)
        Returns an array of Recipe Summary.
        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.
      • listTrailFiles

        Future<ListTrailFilesResponse> listTrailFiles​(ListTrailFilesRequest request,
                                                      AsyncHandler<ListTrailFilesRequest,​ListTrailFilesResponse> handler)
        Lists the TrailFiles for a deployment.

        Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

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

        Future<ListTrailSequencesResponse> listTrailSequences​(ListTrailSequencesRequest request,
                                                              AsyncHandler<ListTrailSequencesRequest,​ListTrailSequencesResponse> handler)
        Lists the Trail Sequences for a TrailFile in a given deployment.

        Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

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

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                                    AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Lists work request errors.
        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.
      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                                AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Lists work request logs.
        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.
      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                          AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in the compartment.
        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.
      • refreshConnection

        Future<RefreshConnectionResponse> refreshConnection​(RefreshConnectionRequest request,
                                                            AsyncHandler<RefreshConnectionRequest,​RefreshConnectionResponse> handler)
        Refresh the external Connection attributes.
        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.
      • removeConnectionLock

        Future<RemoveConnectionLockResponse> removeConnectionLock​(RemoveConnectionLockRequest request,
                                                                  AsyncHandler<RemoveConnectionLockRequest,​RemoveConnectionLockResponse> handler)
        Removes a lock from a Connection 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.
      • removeDeploymentLocalPeer

        Future<RemoveDeploymentLocalPeerResponse> removeDeploymentLocalPeer​(RemoveDeploymentLocalPeerRequest request,
                                                                            AsyncHandler<RemoveDeploymentLocalPeerRequest,​RemoveDeploymentLocalPeerResponse> handler)
        Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute.

        When provided, If-Match is checked against ETag values of the 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.
      • 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.
      • rescheduleDeploymentUpgrade

        Future<RescheduleDeploymentUpgradeResponse> rescheduleDeploymentUpgrade​(RescheduleDeploymentUpgradeRequest request,
                                                                                AsyncHandler<RescheduleDeploymentUpgradeRequest,​RescheduleDeploymentUpgradeResponse> handler)
        Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.

        When provided, If-Match is checked against ETag values of the 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.
      • restoreDeployment

        Future<RestoreDeploymentResponse> restoreDeployment​(RestoreDeploymentRequest request,
                                                            AsyncHandler<RestoreDeploymentRequest,​RestoreDeploymentResponse> handler)
        Restores a Deployment from a Deployment Backup created from the same 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.
      • rollbackDeploymentUpgrade

        Future<RollbackDeploymentUpgradeResponse> rollbackDeploymentUpgrade​(RollbackDeploymentUpgradeRequest request,
                                                                            AsyncHandler<RollbackDeploymentUpgradeRequest,​RollbackDeploymentUpgradeResponse> handler)
        Rollback a deployment to it’s previous version.

        When provided, If-Match is checked against ETag values of the 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.
      • snoozeDeploymentUpgrade

        Future<SnoozeDeploymentUpgradeResponse> snoozeDeploymentUpgrade​(SnoozeDeploymentUpgradeRequest request,
                                                                        AsyncHandler<SnoozeDeploymentUpgradeRequest,​SnoozeDeploymentUpgradeResponse> handler)
        Snooze a DeploymentUpgrade.

        When provided, If-Match is checked against ETag values of the 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.
      • startDeployment

        Future<StartDeploymentResponse> startDeployment​(StartDeploymentRequest request,
                                                        AsyncHandler<StartDeploymentRequest,​StartDeploymentResponse> handler)
        Starts a Deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • startPipeline

        Future<StartPipelineResponse> startPipeline​(StartPipelineRequest request,
                                                    AsyncHandler<StartPipelineRequest,​StartPipelineResponse> handler)
        Starts the pipeline for data replication.
        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.
      • stopDeployment

        Future<StopDeploymentResponse> stopDeployment​(StopDeploymentRequest request,
                                                      AsyncHandler<StopDeploymentRequest,​StopDeploymentResponse> handler)
        Stops a Deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • stopPipeline

        Future<StopPipelineResponse> stopPipeline​(StopPipelineRequest request,
                                                  AsyncHandler<StopPipelineRequest,​StopPipelineResponse> handler)
        Stops the pipeline for data replication.
        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.
      • switchoverDeploymentPeer

        Future<SwitchoverDeploymentPeerResponse> switchoverDeploymentPeer​(SwitchoverDeploymentPeerRequest request,
                                                                          AsyncHandler<SwitchoverDeploymentPeerRequest,​SwitchoverDeploymentPeerResponse> handler)
        Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region.

        When provided, If-Match is checked against ETag values of the 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.
      • testConnectionAssignment

        Future<TestConnectionAssignmentResponse> testConnectionAssignment​(TestConnectionAssignmentRequest request,
                                                                          AsyncHandler<TestConnectionAssignmentRequest,​TestConnectionAssignmentResponse> handler)
        Tests the connectivity between given GoldenGate deployment and one of the associated database / service.

        When provided, If-Match is checked against ETag values of the 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.
      • testPipelineConnection

        Future<TestPipelineConnectionResponse> testPipelineConnection​(TestPipelineConnectionRequest request,
                                                                      AsyncHandler<TestPipelineConnectionRequest,​TestPipelineConnectionResponse> handler)
        Tests pipeline connections against pipeline to verify the connectivity.

        When provided, If-Match is checked against ETag values of the 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.
      • updateConnection

        Future<UpdateConnectionResponse> updateConnection​(UpdateConnectionRequest request,
                                                          AsyncHandler<UpdateConnectionRequest,​UpdateConnectionResponse> handler)
        Updates the Connection.
        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)
        Modifies a 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.
      • updateDeploymentBackup

        Future<UpdateDeploymentBackupResponse> updateDeploymentBackup​(UpdateDeploymentBackupRequest request,
                                                                      AsyncHandler<UpdateDeploymentBackupRequest,​UpdateDeploymentBackupResponse> handler)
        Modifies a Deployment Backup.
        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.
      • updatePipeline

        Future<UpdatePipelineResponse> updatePipeline​(UpdatePipelineRequest request,
                                                      AsyncHandler<UpdatePipelineRequest,​UpdatePipelineResponse> handler)
        Updates the Pipeline.
        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.
      • upgradeDeployment

        Future<UpgradeDeploymentResponse> upgradeDeployment​(UpgradeDeploymentRequest request,
                                                            AsyncHandler<UpgradeDeploymentRequest,​UpgradeDeploymentResponse> handler)
        Upgrade a Deployment.

        When provided, If-Match is checked against ETag values of the 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.
      • upgradeDeploymentUpgrade

        Future<UpgradeDeploymentUpgradeResponse> upgradeDeploymentUpgrade​(UpgradeDeploymentUpgradeRequest request,
                                                                          AsyncHandler<UpgradeDeploymentUpgradeRequest,​UpgradeDeploymentUpgradeResponse> handler)
        Upgrade a deployment.

        When provided, If-Match is checked against ETag values of the 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.