@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
Modifier and Type | Class and Description |
---|---|
static class |
GoldenGateAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for GoldenGate.
|
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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for GoldenGate.
public final String clientCommonLibraryVersion
@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see GoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
public static GoldenGateAsyncClient.Builder builder()
Create a builder for this client.
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 Future<AddConnectionLockResponse> addConnectionLock(AddConnectionLockRequest request, AsyncHandler<AddConnectionLockRequest,AddConnectionLockResponse> handler)
GoldenGateAsync
Adds a lock to a Connection resource.
addConnectionLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AddDeploymentBackupLockResponse> addDeploymentBackupLock(AddDeploymentBackupLockRequest request, AsyncHandler<AddDeploymentBackupLockRequest,AddDeploymentBackupLockResponse> handler)
GoldenGateAsync
Adds a lock to a DeploymentBackup resource.
addDeploymentBackupLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AddDeploymentLockResponse> addDeploymentLock(AddDeploymentLockRequest request, AsyncHandler<AddDeploymentLockRequest,AddDeploymentLockResponse> handler)
GoldenGateAsync
Adds a lock to a Deployment resource.
addDeploymentLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.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<CancelDeploymentUpgradeResponse> cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request, AsyncHandler<CancelDeploymentUpgradeRequest,CancelDeploymentUpgradeResponse> handler)
GoldenGateAsync
Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
cancelDeploymentUpgrade
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CancelSnoozeDeploymentUpgradeResponse> cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request, AsyncHandler<CancelSnoozeDeploymentUpgradeRequest,CancelSnoozeDeploymentUpgradeResponse> handler)
GoldenGateAsync
Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
cancelSnoozeDeploymentUpgrade
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeConnectionCompartmentResponse> changeConnectionCompartment(ChangeConnectionCompartmentRequest request, AsyncHandler<ChangeConnectionCompartmentRequest,ChangeConnectionCompartmentResponse> handler)
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.
changeConnectionCompartment
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
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.
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<CollectDeploymentDiagnosticResponse> collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request, AsyncHandler<CollectDeploymentDiagnosticRequest,CollectDeploymentDiagnosticResponse> handler)
GoldenGateAsync
Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.
collectDeploymentDiagnostic
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CopyDeploymentBackupResponse> copyDeploymentBackup(CopyDeploymentBackupRequest request, AsyncHandler<CopyDeploymentBackupRequest,CopyDeploymentBackupResponse> handler)
GoldenGateAsync
Creates a copy of a Deployment Backup.
copyDeploymentBackup
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)
GoldenGateAsync
Creates a new certificate to truststore.
createCertificate
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
GoldenGateAsync
Creates a new Connection.
createConnection
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateConnectionAssignmentResponse> createConnectionAssignment(CreateConnectionAssignmentRequest request, AsyncHandler<CreateConnectionAssignmentRequest,CreateConnectionAssignmentResponse> handler)
GoldenGateAsync
Creates a new Connection Assignment.
createConnectionAssignment
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
Note: Deprecated. Use the /connections API instead. 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<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResponse> handler)
GoldenGateAsync
Deletes the certificate from truststore.
deleteCertificate
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
GoldenGateAsync
Deletes a Connection.
deleteConnection
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteConnectionAssignmentResponse> deleteConnectionAssignment(DeleteConnectionAssignmentRequest request, AsyncHandler<DeleteConnectionAssignmentRequest,DeleteConnectionAssignmentResponse> handler)
GoldenGateAsync
Deletes a Connection Assignment.
deleteConnectionAssignment
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
Note: Deprecated. Use the /connections API instead. 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<DeploymentWalletExistsResponse> deploymentWalletExists(DeploymentWalletExistsRequest request, AsyncHandler<DeploymentWalletExistsRequest,DeploymentWalletExistsResponse> handler)
GoldenGateAsync
Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.
deploymentWalletExists
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ExportDeploymentWalletResponse> exportDeploymentWallet(ExportDeploymentWalletRequest request, AsyncHandler<ExportDeploymentWalletRequest,ExportDeploymentWalletResponse> handler)
GoldenGateAsync
Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.
exportDeploymentWallet
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GenerateLibraryUrlResponse> generateLibraryUrl(GenerateLibraryUrlRequest request, AsyncHandler<GenerateLibraryUrlRequest,GenerateLibraryUrlResponse> handler)
GoldenGateAsync
Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.
generateLibraryUrl
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetCertificateResponse> getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)
GoldenGateAsync
Retrieves a Certificate.
getCertificate
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetConnectionResponse> getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
GoldenGateAsync
Retrieves a Connection.
getConnection
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetConnectionAssignmentResponse> getConnectionAssignment(GetConnectionAssignmentRequest request, AsyncHandler<GetConnectionAssignmentRequest,GetConnectionAssignmentResponse> handler)
GoldenGateAsync
Retrieves a Connection Assignment.
getConnectionAssignment
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
Note: Deprecated. Use the /connections API instead. 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<ImportDeploymentWalletResponse> importDeploymentWallet(ImportDeploymentWalletRequest request, AsyncHandler<ImportDeploymentWalletRequest,ImportDeploymentWalletResponse> handler)
GoldenGateAsync
Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.
importDeploymentWallet
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)
GoldenGateAsync
Returns a list of certificates from truststore.
listCertificates
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListConnectionAssignmentsResponse> listConnectionAssignments(ListConnectionAssignmentsRequest request, AsyncHandler<ListConnectionAssignmentsRequest,ListConnectionAssignmentsResponse> handler)
GoldenGateAsync
Lists the Connection Assignments in the compartment.
listConnectionAssignments
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
GoldenGateAsync
Lists the Connections in the compartment.
listConnections
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
Note: Deprecated. Use the /connections API instead. 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<ListDeploymentEnvironmentsResponse> listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request, AsyncHandler<ListDeploymentEnvironmentsRequest,ListDeploymentEnvironmentsResponse> handler)
GoldenGateAsync
Returns an array of DeploymentEnvironmentDescriptor
listDeploymentEnvironments
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDeploymentTypesResponse> listDeploymentTypes(ListDeploymentTypesRequest request, AsyncHandler<ListDeploymentTypesRequest,ListDeploymentTypesResponse> handler)
GoldenGateAsync
Returns an array of DeploymentTypeDescriptor
listDeploymentTypes
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<ListDeploymentVersionsResponse> listDeploymentVersions(ListDeploymentVersionsRequest request, AsyncHandler<ListDeploymentVersionsRequest,ListDeploymentVersionsResponse> handler)
GoldenGateAsync
Returns the list of available deployment versions.
listDeploymentVersions
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDeploymentWalletsOperationsResponse> listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request, AsyncHandler<ListDeploymentWalletsOperationsRequest,ListDeploymentWalletsOperationsResponse> handler)
GoldenGateAsync
Lists the wallets export/import operations to/from a deployment.
listDeploymentWalletsOperations
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<ListMessagesResponse> listMessages(ListMessagesRequest request, AsyncHandler<ListMessagesRequest,ListMessagesResponse> handler)
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.
listMessages
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTrailFilesResponse> listTrailFiles(ListTrailFilesRequest request, AsyncHandler<ListTrailFilesRequest,ListTrailFilesResponse> handler)
GoldenGateAsync
Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
listTrailFiles
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTrailSequencesResponse> listTrailSequences(ListTrailSequencesRequest request, AsyncHandler<ListTrailSequencesRequest,ListTrailSequencesResponse> handler)
GoldenGateAsync
Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
listTrailSequences
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<RemoveConnectionLockResponse> removeConnectionLock(RemoveConnectionLockRequest request, AsyncHandler<RemoveConnectionLockRequest,RemoveConnectionLockResponse> handler)
GoldenGateAsync
Removes a lock from a Connection resource.
removeConnectionLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveDeploymentBackupLockResponse> removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request, AsyncHandler<RemoveDeploymentBackupLockRequest,RemoveDeploymentBackupLockResponse> handler)
GoldenGateAsync
Removes a lock from a DeploymentBackup resource.
removeDeploymentBackupLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveDeploymentLockResponse> removeDeploymentLock(RemoveDeploymentLockRequest request, AsyncHandler<RemoveDeploymentLockRequest,RemoveDeploymentLockResponse> handler)
GoldenGateAsync
Removes a lock from a Deployment resource.
removeDeploymentLock
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RescheduleDeploymentUpgradeResponse> rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request, AsyncHandler<RescheduleDeploymentUpgradeRequest,RescheduleDeploymentUpgradeResponse> handler)
GoldenGateAsync
Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
rescheduleDeploymentUpgrade
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<RollbackDeploymentUpgradeResponse> rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request, AsyncHandler<RollbackDeploymentUpgradeRequest,RollbackDeploymentUpgradeResponse> handler)
GoldenGateAsync
Rollback a deployment to it’s previous version. When provided, If-Match is checked against ETag values of the resource.
rollbackDeploymentUpgrade
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SnoozeDeploymentUpgradeResponse> snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request, AsyncHandler<SnoozeDeploymentUpgradeRequest,SnoozeDeploymentUpgradeResponse> handler)
GoldenGateAsync
Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
snoozeDeploymentUpgrade
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<TestConnectionAssignmentResponse> testConnectionAssignment(TestConnectionAssignmentRequest request, AsyncHandler<TestConnectionAssignmentRequest,TestConnectionAssignmentResponse> handler)
GoldenGateAsync
Tests the connectivity between given GoldenGate deployment and one of the associated database / service. When provided, If-Match is checked against ETag values of the resource.
testConnectionAssignment
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
GoldenGateAsync
Updates the Connection.
updateConnection
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
Note: Deprecated. Use the /connections API instead. 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.public Future<UpgradeDeploymentUpgradeResponse> upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request, AsyncHandler<UpgradeDeploymentUpgradeRequest,UpgradeDeploymentUpgradeResponse> handler)
GoldenGateAsync
Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.
upgradeDeploymentUpgrade
in interface GoldenGateAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
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)
Copyright © 2016–2024. All rights reserved.