GoldenGateAsyncClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.goldengate.GoldenGateAsyncClient

All Implemented Interfaces:

GoldenGateAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public class GoldenGateAsyncClient
extends BaseAsyncClient
implements GoldenGateAsync
```
Async client implementation for GoldenGate service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GoldenGateAsyncClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoldenGateAsyncClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for GoldenGate.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for GoldenGate.

Constructor Summary

Constructors
Constructor and Description
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Deprecated. Use the `builder` instead.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GoldenGateAsyncClient.Builder`	`builder()` Create a builder for this client.
`Future<CancelDeploymentBackupResponse>`	`cancelDeploymentBackup(CancelDeploymentBackupRequest request, AsyncHandler<CancelDeploymentBackupRequest,CancelDeploymentBackupResponse> handler)` Cancels a Deployment Backup creation process.
`Future<CancelSnoozeDeploymentUpgradeResponse>`	`cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request, AsyncHandler<CancelSnoozeDeploymentUpgradeRequest,CancelSnoozeDeploymentUpgradeResponse> handler)` Cancel snooze of a DeploymentUpgrade.
`Future<ChangeConnectionCompartmentResponse>`	`changeConnectionCompartment(ChangeConnectionCompartmentRequest request, AsyncHandler<ChangeConnectionCompartmentRequest,ChangeConnectionCompartmentResponse> handler)` Moves the Connection into a different compartment within the same tenancy.
`Future<ChangeDatabaseRegistrationCompartmentResponse>`	`changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request, AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)` Note: Deprecated.
`Future<ChangeDeploymentBackupCompartmentResponse>`	`changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request, AsyncHandler<ChangeDeploymentBackupCompartmentRequest,ChangeDeploymentBackupCompartmentResponse> handler)` Moves a DeploymentBackup into a different compartment within the same tenancy.
`Future<ChangeDeploymentCompartmentResponse>`	`changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request, AsyncHandler<ChangeDeploymentCompartmentRequest,ChangeDeploymentCompartmentResponse> handler)` Moves the Deployment into a different compartment within the same tenancy.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CollectDeploymentDiagnosticResponse>`	`collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request, AsyncHandler<CollectDeploymentDiagnosticRequest,CollectDeploymentDiagnosticResponse> handler)` Collects the diagnostic of a Deployment.
`Future<CreateConnectionResponse>`	`createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)` Creates a new Connection.
`Future<CreateConnectionAssignmentResponse>`	`createConnectionAssignment(CreateConnectionAssignmentRequest request, AsyncHandler<CreateConnectionAssignmentRequest,CreateConnectionAssignmentResponse> handler)` Creates a new Connection Assignment.
`Future<CreateDatabaseRegistrationResponse>`	`createDatabaseRegistration(CreateDatabaseRegistrationRequest request, AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)` Note: Deprecated.
`Future<CreateDeploymentResponse>`	`createDeployment(CreateDeploymentRequest request, AsyncHandler<CreateDeploymentRequest,CreateDeploymentResponse> handler)` Creates a new Deployment.
`Future<CreateDeploymentBackupResponse>`	`createDeploymentBackup(CreateDeploymentBackupRequest request, AsyncHandler<CreateDeploymentBackupRequest,CreateDeploymentBackupResponse> handler)` Creates a new DeploymentBackup.
`Future<DeleteConnectionResponse>`	`deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)` Deletes a Connection.
`Future<DeleteConnectionAssignmentResponse>`	`deleteConnectionAssignment(DeleteConnectionAssignmentRequest request, AsyncHandler<DeleteConnectionAssignmentRequest,DeleteConnectionAssignmentResponse> handler)` Deletes a Connection Assignment.
`Future<DeleteDatabaseRegistrationResponse>`	`deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request, AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)` Note: Deprecated.
`Future<DeleteDeploymentResponse>`	`deleteDeployment(DeleteDeploymentRequest request, AsyncHandler<DeleteDeploymentRequest,DeleteDeploymentResponse> handler)` Deletes the Deployment.
`Future<DeleteDeploymentBackupResponse>`	`deleteDeploymentBackup(DeleteDeploymentBackupRequest request, AsyncHandler<DeleteDeploymentBackupRequest,DeleteDeploymentBackupResponse> handler)` Deletes a DeploymentBackup.
`Future<DeploymentWalletExistsResponse>`	`deploymentWalletExists(DeploymentWalletExistsRequest request, AsyncHandler<DeploymentWalletExistsRequest,DeploymentWalletExistsResponse> handler)` Checks if a wallet is already present in the deployment.
`Future<ExportDeploymentWalletResponse>`	`exportDeploymentWallet(ExportDeploymentWalletRequest request, AsyncHandler<ExportDeploymentWalletRequest,ExportDeploymentWalletResponse> handler)` Export the OGG wallet from the deployment to OCI vault.
`Future<GetConnectionResponse>`	`getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)` Retrieves a Connection.
`Future<GetConnectionAssignmentResponse>`	`getConnectionAssignment(GetConnectionAssignmentRequest request, AsyncHandler<GetConnectionAssignmentRequest,GetConnectionAssignmentResponse> handler)` Retrieves a Connection Assignment.
`Future<GetDatabaseRegistrationResponse>`	`getDatabaseRegistration(GetDatabaseRegistrationRequest request, AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)` Note: Deprecated.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`Future<GetDeploymentResponse>`	`getDeployment(GetDeploymentRequest request, AsyncHandler<GetDeploymentRequest,GetDeploymentResponse> handler)` Retrieves a deployment.
`Future<GetDeploymentBackupResponse>`	`getDeploymentBackup(GetDeploymentBackupRequest request, AsyncHandler<GetDeploymentBackupRequest,GetDeploymentBackupResponse> handler)` Retrieves a DeploymentBackup.
`Future<GetDeploymentUpgradeResponse>`	`getDeploymentUpgrade(GetDeploymentUpgradeRequest request, AsyncHandler<GetDeploymentUpgradeRequest,GetDeploymentUpgradeResponse> handler)` Retrieves a deployment upgrade.
`String`	`getEndpoint()`
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)` Retrieve the WorkRequest identified by the given OCID.
`Future<ImportDeploymentWalletResponse>`	`importDeploymentWallet(ImportDeploymentWalletRequest request, AsyncHandler<ImportDeploymentWalletRequest,ImportDeploymentWalletResponse> handler)` Imports an OGG wallet from the OCI Vault to the Deployment.
`Future<ListConnectionAssignmentsResponse>`	`listConnectionAssignments(ListConnectionAssignmentsRequest request, AsyncHandler<ListConnectionAssignmentsRequest,ListConnectionAssignmentsResponse> handler)` Lists the Connection Assignments in the compartment.
`Future<ListConnectionsResponse>`	`listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)` Lists the Connections in the compartment.
`Future<ListDatabaseRegistrationsResponse>`	`listDatabaseRegistrations(ListDatabaseRegistrationsRequest request, AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)` Note: Deprecated.
`Future<ListDeploymentBackupsResponse>`	`listDeploymentBackups(ListDeploymentBackupsRequest request, AsyncHandler<ListDeploymentBackupsRequest,ListDeploymentBackupsResponse> handler)` Lists the Backups in a compartment.
`Future<ListDeploymentsResponse>`	`listDeployments(ListDeploymentsRequest request, AsyncHandler<ListDeploymentsRequest,ListDeploymentsResponse> handler)` Lists the Deployments in a compartment.
`Future<ListDeploymentTypesResponse>`	`listDeploymentTypes(ListDeploymentTypesRequest request, AsyncHandler<ListDeploymentTypesRequest,ListDeploymentTypesResponse> handler)` Returns an array of DeploymentTypeDescriptor
`Future<ListDeploymentUpgradesResponse>`	`listDeploymentUpgrades(ListDeploymentUpgradesRequest request, AsyncHandler<ListDeploymentUpgradesRequest,ListDeploymentUpgradesResponse> handler)` Lists the Deployment Upgrades in a compartment.
`Future<ListDeploymentVersionsResponse>`	`listDeploymentVersions(ListDeploymentVersionsRequest request, AsyncHandler<ListDeploymentVersionsRequest,ListDeploymentVersionsResponse> handler)` Returns the list of available deployment versions.
`Future<ListDeploymentWalletsOperationsResponse>`	`listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request, AsyncHandler<ListDeploymentWalletsOperationsRequest,ListDeploymentWalletsOperationsResponse> handler)` Lists the wallets export/import operations to/from a deployment.
`Future<ListMessagesResponse>`	`listMessages(ListMessagesRequest request, AsyncHandler<ListMessagesRequest,ListMessagesResponse> handler)` Lists the DeploymentMessages for a deployment.
`Future<ListTrailFilesResponse>`	`listTrailFiles(ListTrailFilesRequest request, AsyncHandler<ListTrailFilesRequest,ListTrailFilesResponse> handler)` Lists the TrailFiles for a deployment.
`Future<ListTrailSequencesResponse>`	`listTrailSequences(ListTrailSequencesRequest request, AsyncHandler<ListTrailSequencesRequest,ListTrailSequencesResponse> handler)` Lists the Trail Sequences for a TrailFile in a given deployment.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)` Lists work request errors.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)` Lists work request logs.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)` Lists the work requests in the compartment.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)` Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()` Rebuild the backing `HttpClient`.
`Future<RestoreDeploymentResponse>`	`restoreDeployment(RestoreDeploymentRequest request, AsyncHandler<RestoreDeploymentRequest,RestoreDeploymentResponse> handler)` Restores a Deployment from a Deployment Backup created from the same Deployment.
`Future<RollbackDeploymentUpgradeResponse>`	`rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request, AsyncHandler<RollbackDeploymentUpgradeRequest,RollbackDeploymentUpgradeResponse> handler)` Rollback a deployment to it’s previous version.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`Future<SnoozeDeploymentUpgradeResponse>`	`snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request, AsyncHandler<SnoozeDeploymentUpgradeRequest,SnoozeDeploymentUpgradeResponse> handler)` Snooze a DeploymentUpgrade.
`Future<StartDeploymentResponse>`	`startDeployment(StartDeploymentRequest request, AsyncHandler<StartDeploymentRequest,StartDeploymentResponse> handler)` Starts a Deployment.
`Future<StopDeploymentResponse>`	`stopDeployment(StopDeploymentRequest request, AsyncHandler<StopDeploymentRequest,StopDeploymentResponse> handler)` Stops a Deployment.
`void`	`updateBaseEndpoint(String endpoint)` This method should be used for parameterized endpoint templates only.
`Future<UpdateConnectionResponse>`	`updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)` Updates the Connection.
`Future<UpdateDatabaseRegistrationResponse>`	`updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request, AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)` Note: Deprecated.
`Future<UpdateDeploymentResponse>`	`updateDeployment(UpdateDeploymentRequest request, AsyncHandler<UpdateDeploymentRequest,UpdateDeploymentResponse> handler)` Modifies a Deployment.
`Future<UpdateDeploymentBackupResponse>`	`updateDeploymentBackup(UpdateDeploymentBackupRequest request, AsyncHandler<UpdateDeploymentBackupRequest,UpdateDeploymentBackupResponse> handler)` Modifies a Deployment Backup.
`Future<UpgradeDeploymentResponse>`	`upgradeDeployment(UpgradeDeploymentRequest request, AsyncHandler<UpgradeDeploymentRequest,UpgradeDeploymentResponse> handler)` Upgrade a Deployment.
`Future<UpgradeDeploymentUpgradeResponse>`	`upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request, AsyncHandler<UpgradeDeploymentUpgradeRequest,UpgradeDeploymentUpgradeResponse> handler)` Upgrade a deployment.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)` This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.goldengate.GoldenGateAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable
close

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GoldenGate.
- Constructor Detail
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - GoldenGateAsyncClient
```
@Deprecated
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)
```
    Deprecated. Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
- Method Detail
  - builder
```
public static GoldenGateAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GoldenGateAsync
    
    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.
    
    Specified by:
    
    setRegion in interface GoldenGateAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GoldenGateAsync
    
    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.
    
    Specified by:
    
    setRegion in interface GoldenGateAsync
    
    Parameters:
    
    regionId - The public region ID.
  - cancelDeploymentBackup
```
public Future<CancelDeploymentBackupResponse> cancelDeploymentBackup(CancelDeploymentBackupRequest request,
                                                                     AsyncHandler<CancelDeploymentBackupRequest,CancelDeploymentBackupResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Cancels a Deployment Backup creation process.
    
    Specified by:
    
    cancelDeploymentBackup in interface GoldenGateAsync
    
    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.
  - cancelSnoozeDeploymentUpgrade
```
public Future<CancelSnoozeDeploymentUpgradeResponse> cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request,
                                                                                   AsyncHandler<CancelSnoozeDeploymentUpgradeRequest,CancelSnoozeDeploymentUpgradeResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    cancelSnoozeDeploymentUpgrade in interface GoldenGateAsync
    
    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.
  - changeConnectionCompartment
```
public Future<ChangeConnectionCompartmentResponse> changeConnectionCompartment(ChangeConnectionCompartmentRequest request,
                                                                               AsyncHandler<ChangeConnectionCompartmentRequest,ChangeConnectionCompartmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeConnectionCompartment in interface GoldenGateAsync
    
    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.
  - changeDatabaseRegistrationCompartment
```
public Future<ChangeDatabaseRegistrationCompartmentResponse> changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request,
                                                                                                   AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDatabaseRegistrationCompartment in interface GoldenGateAsync
    
    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.
  - changeDeploymentBackupCompartment
```
public Future<ChangeDeploymentBackupCompartmentResponse> changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request,
                                                                                           AsyncHandler<ChangeDeploymentBackupCompartmentRequest,ChangeDeploymentBackupCompartmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDeploymentBackupCompartment in interface GoldenGateAsync
    
    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.
  - changeDeploymentCompartment
```
public Future<ChangeDeploymentCompartmentResponse> changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request,
                                                                               AsyncHandler<ChangeDeploymentCompartmentRequest,ChangeDeploymentCompartmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDeploymentCompartment in interface GoldenGateAsync
    
    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
```
public Future<CollectDeploymentDiagnosticResponse> collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request,
                                                                               AsyncHandler<CollectDeploymentDiagnosticRequest,CollectDeploymentDiagnosticResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    collectDeploymentDiagnostic in interface GoldenGateAsync
    
    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
```
public Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request,
                                                         AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Creates a new Connection.
    
    Specified by:
    
    createConnection in interface GoldenGateAsync
    
    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.
  - createConnectionAssignment
```
public Future<CreateConnectionAssignmentResponse> createConnectionAssignment(CreateConnectionAssignmentRequest request,
                                                                             AsyncHandler<CreateConnectionAssignmentRequest,CreateConnectionAssignmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Creates a new Connection Assignment.
    
    Specified by:
    
    createConnectionAssignment in interface GoldenGateAsync
    
    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
```
public Future<CreateDatabaseRegistrationResponse> createDatabaseRegistration(CreateDatabaseRegistrationRequest request,
                                                                             AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.
    
    Specified by:
    
    createDatabaseRegistration in interface GoldenGateAsync
    
    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
```
public Future<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest request,
                                                         AsyncHandler<CreateDeploymentRequest,CreateDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Creates a new Deployment.
    
    Specified by:
    
    createDeployment in interface GoldenGateAsync
    
    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
```
public Future<CreateDeploymentBackupResponse> createDeploymentBackup(CreateDeploymentBackupRequest request,
                                                                     AsyncHandler<CreateDeploymentBackupRequest,CreateDeploymentBackupResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Creates a new DeploymentBackup.
    
    Specified by:
    
    createDeploymentBackup in interface GoldenGateAsync
    
    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
```
public Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request,
                                                         AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Deletes a Connection.
    
    Specified by:
    
    deleteConnection in interface GoldenGateAsync
    
    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.
  - deleteConnectionAssignment
```
public Future<DeleteConnectionAssignmentResponse> deleteConnectionAssignment(DeleteConnectionAssignmentRequest request,
                                                                             AsyncHandler<DeleteConnectionAssignmentRequest,DeleteConnectionAssignmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Deletes a Connection Assignment.
    
    Specified by:
    
    deleteConnectionAssignment in interface GoldenGateAsync
    
    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.
  - deleteDatabaseRegistration
```
public Future<DeleteDatabaseRegistrationResponse> deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request,
                                                                             AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.
    
    Specified by:
    
    deleteDatabaseRegistration in interface GoldenGateAsync
    
    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
```
public Future<DeleteDeploymentResponse> deleteDeployment(DeleteDeploymentRequest request,
                                                         AsyncHandler<DeleteDeploymentRequest,DeleteDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Deletes the Deployment.
    
    Specified by:
    
    deleteDeployment in interface GoldenGateAsync
    
    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.
  - deleteDeploymentBackup
```
public Future<DeleteDeploymentBackupResponse> deleteDeploymentBackup(DeleteDeploymentBackupRequest request,
                                                                     AsyncHandler<DeleteDeploymentBackupRequest,DeleteDeploymentBackupResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Deletes a DeploymentBackup.
    
    Specified by:
    
    deleteDeploymentBackup in interface GoldenGateAsync
    
    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
```
public Future<DeploymentWalletExistsResponse> deploymentWalletExists(DeploymentWalletExistsRequest request,
                                                                     AsyncHandler<DeploymentWalletExistsRequest,DeploymentWalletExistsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    deploymentWalletExists in interface GoldenGateAsync
    
    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
```
public Future<ExportDeploymentWalletResponse> exportDeploymentWallet(ExportDeploymentWalletRequest request,
                                                                     AsyncHandler<ExportDeploymentWalletRequest,ExportDeploymentWalletResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    exportDeploymentWallet in interface GoldenGateAsync
    
    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
```
public Future<GetConnectionResponse> getConnection(GetConnectionRequest request,
                                                   AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieves a Connection.
    
    Specified by:
    
    getConnection in interface GoldenGateAsync
    
    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.
  - getConnectionAssignment
```
public Future<GetConnectionAssignmentResponse> getConnectionAssignment(GetConnectionAssignmentRequest request,
                                                                       AsyncHandler<GetConnectionAssignmentRequest,GetConnectionAssignmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieves a Connection Assignment.
    
    Specified by:
    
    getConnectionAssignment in interface GoldenGateAsync
    
    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
```
public Future<GetDatabaseRegistrationResponse> getDatabaseRegistration(GetDatabaseRegistrationRequest request,
                                                                       AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.
    
    Specified by:
    
    getDatabaseRegistration in interface GoldenGateAsync
    
    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
```
public Future<GetDeploymentResponse> getDeployment(GetDeploymentRequest request,
                                                   AsyncHandler<GetDeploymentRequest,GetDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieves a deployment.
    
    Specified by:
    
    getDeployment in interface GoldenGateAsync
    
    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
```
public Future<GetDeploymentBackupResponse> getDeploymentBackup(GetDeploymentBackupRequest request,
                                                               AsyncHandler<GetDeploymentBackupRequest,GetDeploymentBackupResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieves a DeploymentBackup.
    
    Specified by:
    
    getDeploymentBackup in interface GoldenGateAsync
    
    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
```
public Future<GetDeploymentUpgradeResponse> getDeploymentUpgrade(GetDeploymentUpgradeRequest request,
                                                                 AsyncHandler<GetDeploymentUpgradeRequest,GetDeploymentUpgradeResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieves a deployment upgrade.
    
    Specified by:
    
    getDeploymentUpgrade in interface GoldenGateAsync
    
    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
```
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Retrieve the WorkRequest identified by the given OCID.
    
    Specified by:
    
    getWorkRequest in interface GoldenGateAsync
    
    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
```
public Future<ImportDeploymentWalletResponse> importDeploymentWallet(ImportDeploymentWalletRequest request,
                                                                     AsyncHandler<ImportDeploymentWalletRequest,ImportDeploymentWalletResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    importDeploymentWallet in interface GoldenGateAsync
    
    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.
  - listConnectionAssignments
```
public Future<ListConnectionAssignmentsResponse> listConnectionAssignments(ListConnectionAssignmentsRequest request,
                                                                           AsyncHandler<ListConnectionAssignmentsRequest,ListConnectionAssignmentsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Connection Assignments in the compartment.
    
    Specified by:
    
    listConnectionAssignments in interface GoldenGateAsync
    
    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
```
public Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request,
                                                       AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Connections in the compartment.
    
    Specified by:
    
    listConnections in interface GoldenGateAsync
    
    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
```
public Future<ListDatabaseRegistrationsResponse> listDatabaseRegistrations(ListDatabaseRegistrationsRequest request,
                                                                           AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
    
    Specified by:
    
    listDatabaseRegistrations in interface GoldenGateAsync
    
    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
```
public Future<ListDeploymentBackupsResponse> listDeploymentBackups(ListDeploymentBackupsRequest request,
                                                                   AsyncHandler<ListDeploymentBackupsRequest,ListDeploymentBackupsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Backups in a compartment.
    
    Specified by:
    
    listDeploymentBackups in interface GoldenGateAsync
    
    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
```
public Future<ListDeploymentTypesResponse> listDeploymentTypes(ListDeploymentTypesRequest request,
                                                               AsyncHandler<ListDeploymentTypesRequest,ListDeploymentTypesResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Returns an array of DeploymentTypeDescriptor
    
    Specified by:
    
    listDeploymentTypes in interface GoldenGateAsync
    
    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
```
public Future<ListDeploymentUpgradesResponse> listDeploymentUpgrades(ListDeploymentUpgradesRequest request,
                                                                     AsyncHandler<ListDeploymentUpgradesRequest,ListDeploymentUpgradesResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Deployment Upgrades in a compartment.
    
    Specified by:
    
    listDeploymentUpgrades in interface GoldenGateAsync
    
    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
```
public Future<ListDeploymentVersionsResponse> listDeploymentVersions(ListDeploymentVersionsRequest request,
                                                                     AsyncHandler<ListDeploymentVersionsRequest,ListDeploymentVersionsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Returns the list of available deployment versions.
    
    Specified by:
    
    listDeploymentVersions in interface GoldenGateAsync
    
    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.
  - listDeploymentWalletsOperations
```
public Future<ListDeploymentWalletsOperationsResponse> listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request,
                                                                                       AsyncHandler<ListDeploymentWalletsOperationsRequest,ListDeploymentWalletsOperationsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the wallets export/import operations to/from a deployment.
    
    Specified by:
    
    listDeploymentWalletsOperations in interface GoldenGateAsync
    
    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
```
public Future<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest request,
                                                       AsyncHandler<ListDeploymentsRequest,ListDeploymentsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Deployments in a compartment.
    
    Specified by:
    
    listDeployments in interface GoldenGateAsync
    
    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
```
public Future<ListMessagesResponse> listMessages(ListMessagesRequest request,
                                                 AsyncHandler<ListMessagesRequest,ListMessagesResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
    
    Specified by:
    
    listMessages in interface GoldenGateAsync
    
    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
```
public Future<ListTrailFilesResponse> listTrailFiles(ListTrailFilesRequest request,
                                                     AsyncHandler<ListTrailFilesRequest,ListTrailFilesResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the TrailFiles for a deployment.
    
    Specified by:
    
    listTrailFiles in interface GoldenGateAsync
    
    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
```
public Future<ListTrailSequencesResponse> listTrailSequences(ListTrailSequencesRequest request,
                                                             AsyncHandler<ListTrailSequencesRequest,ListTrailSequencesResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the Trail Sequences for a TrailFile in a given deployment.
    
    Specified by:
    
    listTrailSequences in interface GoldenGateAsync
    
    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
```
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists work request errors.
    
    Specified by:
    
    listWorkRequestErrors in interface GoldenGateAsync
    
    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
```
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists work request logs.
    
    Specified by:
    
    listWorkRequestLogs in interface GoldenGateAsync
    
    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
```
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Lists the work requests in the compartment.
    
    Specified by:
    
    listWorkRequests in interface GoldenGateAsync
    
    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
```
public Future<RestoreDeploymentResponse> restoreDeployment(RestoreDeploymentRequest request,
                                                           AsyncHandler<RestoreDeploymentRequest,RestoreDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Restores a Deployment from a Deployment Backup created from the same Deployment.
    
    Specified by:
    
    restoreDeployment in interface GoldenGateAsync
    
    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
```
public Future<RollbackDeploymentUpgradeResponse> rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request,
                                                                           AsyncHandler<RollbackDeploymentUpgradeRequest,RollbackDeploymentUpgradeResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Rollback a deployment to it’s previous version. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    rollbackDeploymentUpgrade in interface GoldenGateAsync
    
    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
```
public Future<SnoozeDeploymentUpgradeResponse> snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request,
                                                                       AsyncHandler<SnoozeDeploymentUpgradeRequest,SnoozeDeploymentUpgradeResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    snoozeDeploymentUpgrade in interface GoldenGateAsync
    
    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
```
public Future<StartDeploymentResponse> startDeployment(StartDeploymentRequest request,
                                                       AsyncHandler<StartDeploymentRequest,StartDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    startDeployment in interface GoldenGateAsync
    
    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
```
public Future<StopDeploymentResponse> stopDeployment(StopDeploymentRequest request,
                                                     AsyncHandler<StopDeploymentRequest,StopDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    stopDeployment in interface GoldenGateAsync
    
    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
```
public Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request,
                                                         AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Updates the Connection.
    
    Specified by:
    
    updateConnection in interface GoldenGateAsync
    
    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.
  - updateDatabaseRegistration
```
public Future<UpdateDatabaseRegistrationResponse> updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request,
                                                                             AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.
    
    Specified by:
    
    updateDatabaseRegistration in interface GoldenGateAsync
    
    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
```
public Future<UpdateDeploymentResponse> updateDeployment(UpdateDeploymentRequest request,
                                                         AsyncHandler<UpdateDeploymentRequest,UpdateDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Modifies a Deployment.
    
    Specified by:
    
    updateDeployment in interface GoldenGateAsync
    
    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
```
public Future<UpdateDeploymentBackupResponse> updateDeploymentBackup(UpdateDeploymentBackupRequest request,
                                                                     AsyncHandler<UpdateDeploymentBackupRequest,UpdateDeploymentBackupResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Modifies a Deployment Backup.
    
    Specified by:
    
    updateDeploymentBackup in interface GoldenGateAsync
    
    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
```
public Future<UpgradeDeploymentResponse> upgradeDeployment(UpgradeDeploymentRequest request,
                                                           AsyncHandler<UpgradeDeploymentRequest,UpgradeDeploymentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    upgradeDeployment in interface GoldenGateAsync
    
    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
```
public Future<UpgradeDeploymentUpgradeResponse> upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request,
                                                                         AsyncHandler<UpgradeDeploymentUpgradeRequest,UpgradeDeploymentUpgradeResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    upgradeDeploymentUpgrade in interface GoldenGateAsync
    
    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.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)
```

Class GoldenGateAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.goldengate.GoldenGateAsync

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE

Constructor Detail

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

Method Detail

builder

setRegion

setRegion

cancelDeploymentBackup

cancelSnoozeDeploymentUpgrade

changeConnectionCompartment

changeDatabaseRegistrationCompartment

changeDeploymentBackupCompartment

changeDeploymentCompartment

collectDeploymentDiagnostic

createConnection

createConnectionAssignment

createDatabaseRegistration

createDeployment

createDeploymentBackup

deleteConnection

deleteConnectionAssignment

deleteDatabaseRegistration

deleteDeployment

deleteDeploymentBackup

deploymentWalletExists

exportDeploymentWallet

getConnection

getConnectionAssignment

getDatabaseRegistration

getDeployment

getDeploymentBackup

getDeploymentUpgrade

getWorkRequest

importDeploymentWallet

listConnectionAssignments

listConnections

listDatabaseRegistrations

listDeploymentBackups

listDeploymentTypes

listDeploymentUpgrades

listDeploymentVersions

listDeploymentWalletsOperations

listDeployments

listMessages

listTrailFiles

listTrailSequences

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

restoreDeployment

rollbackDeploymentUpgrade

snoozeDeploymentUpgrade

startDeployment

stopDeployment

updateConnection

updateDatabaseRegistration

updateDeployment

updateDeploymentBackup

upgradeDeployment

upgradeDeploymentUpgrade

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint