@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:
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. Modifier and Type | Class and Description |
---|---|
static class |
GoldenGateAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for GoldenGate.
|
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.
|
public static final Service SERVICE
Service instance for GoldenGate.
public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.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.
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.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.
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.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.
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.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.
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
)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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)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.
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 signeradditionalClientConfigurators
- 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
public static GoldenGateAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
GoldenGateAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface GoldenGateAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
GoldenGateAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface GoldenGateAsync
public void setRegion(Region region)
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.
setRegion
in interface GoldenGateAsync
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface GoldenGateAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<CancelDeploymentBackupResponse> cancelDeploymentBackup(CancelDeploymentBackupRequest request, AsyncHandler<CancelDeploymentBackupRequest,CancelDeploymentBackupResponse> handler)
GoldenGateAsync
Cancels a Deployment Backup creation process.
cancelDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDatabaseRegistrationCompartmentResponse> changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request, AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)
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.
changeDatabaseRegistrationCompartment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDeploymentBackupCompartmentResponse> changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request, AsyncHandler<ChangeDeploymentBackupCompartmentRequest,ChangeDeploymentBackupCompartmentResponse> handler)
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.
changeDeploymentBackupCompartment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDeploymentCompartmentResponse> changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request, AsyncHandler<ChangeDeploymentCompartmentRequest,ChangeDeploymentCompartmentResponse> handler)
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.
changeDeploymentCompartment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDatabaseRegistrationResponse> createDatabaseRegistration(CreateDatabaseRegistrationRequest request, AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)
GoldenGateAsync
Creates a new DatabaseRegistration.
createDatabaseRegistration
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest request, AsyncHandler<CreateDeploymentRequest,CreateDeploymentResponse> handler)
GoldenGateAsync
Creates a new Deployment.
createDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDeploymentBackupResponse> createDeploymentBackup(CreateDeploymentBackupRequest request, AsyncHandler<CreateDeploymentBackupRequest,CreateDeploymentBackupResponse> handler)
GoldenGateAsync
Creates a new DeploymentBackup.
createDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDatabaseRegistrationResponse> deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request, AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)
GoldenGateAsync
Deletes a DatabaseRegistration.
deleteDatabaseRegistration
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDeploymentResponse> deleteDeployment(DeleteDeploymentRequest request, AsyncHandler<DeleteDeploymentRequest,DeleteDeploymentResponse> handler)
GoldenGateAsync
Deletes the Deployment.
deleteDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDeploymentBackupResponse> deleteDeploymentBackup(DeleteDeploymentBackupRequest request, AsyncHandler<DeleteDeploymentBackupRequest,DeleteDeploymentBackupResponse> handler)
GoldenGateAsync
Deletes a DeploymentBackup.
deleteDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDatabaseRegistrationResponse> getDatabaseRegistration(GetDatabaseRegistrationRequest request, AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)
GoldenGateAsync
Retrieves a DatabaseRegistration.
getDatabaseRegistration
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDeploymentResponse> getDeployment(GetDeploymentRequest request, AsyncHandler<GetDeploymentRequest,GetDeploymentResponse> handler)
GoldenGateAsync
Retrieves a deployment.
getDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDeploymentBackupResponse> getDeploymentBackup(GetDeploymentBackupRequest request, AsyncHandler<GetDeploymentBackupRequest,GetDeploymentBackupResponse> handler)
GoldenGateAsync
Retrieves a DeploymentBackup.
getDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDeploymentUpgradeResponse> getDeploymentUpgrade(GetDeploymentUpgradeRequest request, AsyncHandler<GetDeploymentUpgradeRequest,GetDeploymentUpgradeResponse> handler)
GoldenGateAsync
Retrieves a deployment upgrade.
getDeploymentUpgrade
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
GoldenGateAsync
Retrieve the WorkRequest identified by the given OCID.
getWorkRequest
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDatabaseRegistrationsResponse> listDatabaseRegistrations(ListDatabaseRegistrationsRequest request, AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)
GoldenGateAsync
Lists the DatabaseRegistrations in the compartment.
listDatabaseRegistrations
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDeploymentBackupsResponse> listDeploymentBackups(ListDeploymentBackupsRequest request, AsyncHandler<ListDeploymentBackupsRequest,ListDeploymentBackupsResponse> handler)
GoldenGateAsync
Lists the Backups in a compartment.
listDeploymentBackups
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDeploymentUpgradesResponse> listDeploymentUpgrades(ListDeploymentUpgradesRequest request, AsyncHandler<ListDeploymentUpgradesRequest,ListDeploymentUpgradesResponse> handler)
GoldenGateAsync
Lists the Deployment Upgrades in a compartment.
listDeploymentUpgrades
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest request, AsyncHandler<ListDeploymentsRequest,ListDeploymentsResponse> handler)
GoldenGateAsync
Lists the Deployments in a compartment.
listDeployments
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
GoldenGateAsync
Lists work request errors.
listWorkRequestErrors
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
GoldenGateAsync
Lists work request logs.
listWorkRequestLogs
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
GoldenGateAsync
Lists the work requests in the compartment.
listWorkRequests
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RestoreDeploymentResponse> restoreDeployment(RestoreDeploymentRequest request, AsyncHandler<RestoreDeploymentRequest,RestoreDeploymentResponse> handler)
GoldenGateAsync
Restores a Deployment from a Deployment Backup created from the same Deployment.
restoreDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<StartDeploymentResponse> startDeployment(StartDeploymentRequest request, AsyncHandler<StartDeploymentRequest,StartDeploymentResponse> handler)
GoldenGateAsync
Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
startDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<StopDeploymentResponse> stopDeployment(StopDeploymentRequest request, AsyncHandler<StopDeploymentRequest,StopDeploymentResponse> handler)
GoldenGateAsync
Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
stopDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDatabaseRegistrationResponse> updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request, AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)
GoldenGateAsync
Updates the DatabaseRegistration.
updateDatabaseRegistration
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDeploymentResponse> updateDeployment(UpdateDeploymentRequest request, AsyncHandler<UpdateDeploymentRequest,UpdateDeploymentResponse> handler)
GoldenGateAsync
Modifies a Deployment.
updateDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDeploymentBackupResponse> updateDeploymentBackup(UpdateDeploymentBackupRequest request, AsyncHandler<UpdateDeploymentBackupRequest,UpdateDeploymentBackupResponse> handler)
GoldenGateAsync
Modifies a Deployment Backup.
updateDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpgradeDeploymentResponse> upgradeDeployment(UpgradeDeploymentRequest request, AsyncHandler<UpgradeDeploymentRequest,UpgradeDeploymentResponse> handler)
GoldenGateAsync
Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
upgradeDeployment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.