GoldenGateAsyncClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.goldengate.GoldenGateAsyncClient

All Implemented Interfaces:

GoldenGateAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public class GoldenGateAsyncClient
extends Object
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)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
`GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

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<ChangeDatabaseRegistrationCompartmentResponse>`	`changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request, AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)` Moves the DatabaseRegistration into a different compartment within the same tenancy.
`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.
`void`	`close()`
`Future<CreateDatabaseRegistrationResponse>`	`createDatabaseRegistration(CreateDatabaseRegistrationRequest request, AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)` Creates a new DatabaseRegistration.
`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<DeleteDatabaseRegistrationResponse>`	`deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request, AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)` Deletes a DatabaseRegistration.
`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<GetDatabaseRegistrationResponse>`	`getDatabaseRegistration(GetDatabaseRegistrationRequest request, AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)` Retrieves a DatabaseRegistration.
`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()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)` Retrieve the WorkRequest identified by the given OCID.
`Future<ListDatabaseRegistrationsResponse>`	`listDatabaseRegistrations(ListDatabaseRegistrationsRequest request, AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)` Lists the DatabaseRegistrations in the compartment.
`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<ListDeploymentUpgradesResponse>`	`listDeploymentUpgrades(ListDeploymentUpgradesRequest request, AsyncHandler<ListDeploymentUpgradesRequest,ListDeploymentUpgradesResponse> handler)` Lists the Deployment Upgrades in a compartment.
`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.
`Future<RestoreDeploymentResponse>`	`restoreDeployment(RestoreDeploymentRequest request, AsyncHandler<RestoreDeploymentRequest,RestoreDeploymentResponse> handler)` Restores a Deployment from a Deployment Backup created from the same Deployment.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`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<StartDeploymentResponse>`	`startDeployment(StartDeploymentRequest request, AsyncHandler<StartDeploymentRequest,StartDeploymentResponse> handler)` Starts a Deployment.
`Future<StopDeploymentResponse>`	`stopDeployment(StopDeploymentRequest request, AsyncHandler<StopDeploymentRequest,StopDeploymentResponse> handler)` Stops a Deployment.
`Future<UpdateDatabaseRegistrationResponse>`	`updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request, AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)` Updates the DatabaseRegistration.
`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.

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

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GoldenGate.
- Constructor Detail
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - GoldenGateAsyncClient
```
public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static GoldenGateAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: GoldenGateAsync
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface GoldenGateAsync
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: GoldenGateAsync
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface GoldenGateAsync
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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.
  - changeDatabaseRegistrationCompartment
```
public Future<ChangeDatabaseRegistrationCompartmentResponse> changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request,
                                                                                                   AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
  - createDatabaseRegistration
```
public Future<CreateDatabaseRegistrationResponse> createDatabaseRegistration(CreateDatabaseRegistrationRequest request,
                                                                             AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
  - deleteDatabaseRegistration
```
public Future<DeleteDatabaseRegistrationResponse> deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request,
                                                                             AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
  - getDatabaseRegistration
```
public Future<GetDatabaseRegistrationResponse> getDatabaseRegistration(GetDatabaseRegistrationRequest request,
                                                                       AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
  - listDatabaseRegistrations
```
public Future<ListDatabaseRegistrationsResponse> listDatabaseRegistrations(ListDatabaseRegistrationsRequest request,
                                                                           AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.
  - 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.
  - 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.
  - 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.
  - 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.
  - updateDatabaseRegistration
```
public Future<UpdateDatabaseRegistrationResponse> updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request,
                                                                             AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)
```
    Description copied from interface: GoldenGateAsync
    
    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.

Class GoldenGateAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

GoldenGateAsyncClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

cancelDeploymentBackup

changeDatabaseRegistrationCompartment

changeDeploymentBackupCompartment

changeDeploymentCompartment

createDatabaseRegistration

createDeployment

createDeploymentBackup

deleteDatabaseRegistration

deleteDeployment

deleteDeploymentBackup

getDatabaseRegistration

getDeployment

getDeploymentBackup

getDeploymentUpgrade

getWorkRequest

listDatabaseRegistrations

listDeploymentBackups

listDeploymentUpgrades

listDeployments

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

restoreDeployment

startDeployment

stopDeployment

updateDatabaseRegistration

updateDeployment

updateDeploymentBackup

upgradeDeployment