Class GoldenGateAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.goldengate.GoldenGateAsyncClient
-
- All Implemented Interfaces:
GoldenGateAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200407") public class GoldenGateAsyncClient extends BaseAsyncClient implements GoldenGateAsync
Async client implementation for GoldenGate service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, 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 Description static class
GoldenGateAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor Description GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.goldengate.GoldenGateAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static GoldenGateAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:GoldenGateAsync
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegion
in interfaceGoldenGateAsync
- 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 callsetEndpoint
.- Specified by:
setRegion
in interfaceGoldenGateAsync
- Parameters:
regionId
- The public region ID.
-
addConnectionLock
public Future<AddConnectionLockResponse> addConnectionLock(AddConnectionLockRequest request, AsyncHandler<AddConnectionLockRequest,AddConnectionLockResponse> handler)
Description copied from interface:GoldenGateAsync
Adds a lock to a Connection resource.- Specified by:
addConnectionLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addDeploymentBackupLock
public Future<AddDeploymentBackupLockResponse> addDeploymentBackupLock(AddDeploymentBackupLockRequest request, AsyncHandler<AddDeploymentBackupLockRequest,AddDeploymentBackupLockResponse> handler)
Description copied from interface:GoldenGateAsync
Adds a lock to a DeploymentBackup resource.- Specified by:
addDeploymentBackupLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addDeploymentLocalPeer
public Future<AddDeploymentLocalPeerResponse> addDeploymentLocalPeer(AddDeploymentLocalPeerRequest request, AsyncHandler<AddDeploymentLocalPeerRequest,AddDeploymentLocalPeerResponse> handler)
Description copied from interface:GoldenGateAsync
Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
addDeploymentLocalPeer
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addDeploymentLock
public Future<AddDeploymentLockResponse> addDeploymentLock(AddDeploymentLockRequest request, AsyncHandler<AddDeploymentLockRequest,AddDeploymentLockResponse> handler)
Description copied from interface:GoldenGateAsync
Adds a lock to a Deployment resource.- Specified by:
addDeploymentLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
cancelDeploymentBackup
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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
cancelDeploymentUpgrade
public Future<CancelDeploymentUpgradeResponse> cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request, AsyncHandler<CancelDeploymentUpgradeRequest,CancelDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
cancelDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
cancelSnoozeDeploymentUpgrade
public Future<CancelSnoozeDeploymentUpgradeResponse> cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request, AsyncHandler<CancelSnoozeDeploymentUpgradeRequest,CancelSnoozeDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Cancel snooze of a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
cancelSnoozeDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeConnectionCompartment
public Future<ChangeConnectionCompartmentResponse> changeConnectionCompartment(ChangeConnectionCompartmentRequest request, AsyncHandler<ChangeConnectionCompartmentRequest,ChangeConnectionCompartmentResponse> handler)
Description copied from interface:GoldenGateAsync
Moves the Connection into a different compartment within the same tenancy.When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
- Specified by:
changeConnectionCompartment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeDatabaseRegistrationCompartment
public Future<ChangeDatabaseRegistrationCompartmentResponse> changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request, AsyncHandler<ChangeDatabaseRegistrationCompartmentRequest,ChangeDatabaseRegistrationCompartmentResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
- Specified by:
changeDatabaseRegistrationCompartment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
changePipelineCompartment
public Future<ChangePipelineCompartmentResponse> changePipelineCompartment(ChangePipelineCompartmentRequest request, AsyncHandler<ChangePipelineCompartmentRequest,ChangePipelineCompartmentResponse> handler)
Description copied from interface:GoldenGateAsync
Moves the Pipeline 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:
changePipelineCompartment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
collectDeploymentDiagnostic
public Future<CollectDeploymentDiagnosticResponse> collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request, AsyncHandler<CollectDeploymentDiagnosticRequest,CollectDeploymentDiagnosticResponse> handler)
Description copied from interface:GoldenGateAsync
Collects the diagnostic of a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
collectDeploymentDiagnostic
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
collectPipelineDiagnostic
public Future<CollectPipelineDiagnosticResponse> collectPipelineDiagnostic(CollectPipelineDiagnosticRequest request, AsyncHandler<CollectPipelineDiagnosticRequest,CollectPipelineDiagnosticResponse> handler)
Description copied from interface:GoldenGateAsync
Collects diagnostics for the pipeline- Specified by:
collectPipelineDiagnostic
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
copyDeploymentBackup
public Future<CopyDeploymentBackupResponse> copyDeploymentBackup(CopyDeploymentBackupRequest request, AsyncHandler<CopyDeploymentBackupRequest,CopyDeploymentBackupResponse> handler)
Description copied from interface:GoldenGateAsync
Creates a copy of a Deployment Backup.- Specified by:
copyDeploymentBackup
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createCertificate
public Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)
Description copied from interface:GoldenGateAsync
Creates a new certificate to truststore.- Specified by:
createCertificate
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createConnection
public Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Creates a new Connection.- Specified by:
createConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createConnectionAssignment
public Future<CreateConnectionAssignmentResponse> createConnectionAssignment(CreateConnectionAssignmentRequest request, AsyncHandler<CreateConnectionAssignmentRequest,CreateConnectionAssignmentResponse> handler)
Description copied from interface:GoldenGateAsync
Creates a new Connection Assignment.- Specified by:
createConnectionAssignment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createDatabaseRegistration
public Future<CreateDatabaseRegistrationResponse> createDatabaseRegistration(CreateDatabaseRegistrationRequest request, AsyncHandler<CreateDatabaseRegistrationRequest,CreateDatabaseRegistrationResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Creates a new DatabaseRegistration.
- Specified by:
createDatabaseRegistration
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createPipeline
public Future<CreatePipelineResponse> createPipeline(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Creates a new Pipeline.- Specified by:
createPipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteCertificate
public Future<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResponse> handler)
Description copied from interface:GoldenGateAsync
Deletes the certificate from truststore.- Specified by:
deleteCertificate
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteConnection
public Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Deletes a Connection.- Specified by:
deleteConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteConnectionAssignment
public Future<DeleteConnectionAssignmentResponse> deleteConnectionAssignment(DeleteConnectionAssignmentRequest request, AsyncHandler<DeleteConnectionAssignmentRequest,DeleteConnectionAssignmentResponse> handler)
Description copied from interface:GoldenGateAsync
Deletes a Connection Assignment.- Specified by:
deleteConnectionAssignment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteDatabaseRegistration
public Future<DeleteDatabaseRegistrationResponse> deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request, AsyncHandler<DeleteDatabaseRegistrationRequest,DeleteDatabaseRegistrationResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Deletes a DatabaseRegistration.
- Specified by:
deleteDatabaseRegistration
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deletePipeline
public Future<DeletePipelineResponse> deletePipeline(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Deletes a Pipeline.- Specified by:
deletePipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deploymentWalletExists
public Future<DeploymentWalletExistsResponse> deploymentWalletExists(DeploymentWalletExistsRequest request, AsyncHandler<DeploymentWalletExistsRequest,DeploymentWalletExistsResponse> handler)
Description copied from interface:GoldenGateAsync
Checks if a wallet is already present in the deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
deploymentWalletExists
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
exportDeploymentWallet
public Future<ExportDeploymentWalletResponse> exportDeploymentWallet(ExportDeploymentWalletRequest request, AsyncHandler<ExportDeploymentWalletRequest,ExportDeploymentWalletResponse> handler)
Description copied from interface:GoldenGateAsync
Export the OGG wallet from the deployment to OCI vault.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
exportDeploymentWallet
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
generateLibraryUrl
public Future<GenerateLibraryUrlResponse> generateLibraryUrl(GenerateLibraryUrlRequest request, AsyncHandler<GenerateLibraryUrlRequest,GenerateLibraryUrlResponse> handler)
Description copied from interface: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.
- Specified by:
generateLibraryUrl
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getCertificate
public Future<GetCertificateResponse> getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Certificate.- Specified by:
getCertificate
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getConnection
public Future<GetConnectionResponse> getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Connection.- Specified by:
getConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getConnectionAssignment
public Future<GetConnectionAssignmentResponse> getConnectionAssignment(GetConnectionAssignmentRequest request, AsyncHandler<GetConnectionAssignmentRequest,GetConnectionAssignmentResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Connection Assignment.- Specified by:
getConnectionAssignment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDatabaseRegistration
public Future<GetDatabaseRegistrationResponse> getDatabaseRegistration(GetDatabaseRegistrationRequest request, AsyncHandler<GetDatabaseRegistrationRequest,GetDatabaseRegistrationResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Retrieves a DatabaseRegistration.
- Specified by:
getDatabaseRegistration
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getPipeline
public Future<GetPipelineResponse> getPipeline(GetPipelineRequest request, AsyncHandler<GetPipelineRequest,GetPipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Pipeline details.- Specified by:
getPipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
importDeploymentWallet
public Future<ImportDeploymentWalletResponse> importDeploymentWallet(ImportDeploymentWalletRequest request, AsyncHandler<ImportDeploymentWalletRequest,ImportDeploymentWalletResponse> handler)
Description copied from interface:GoldenGateAsync
Imports an OGG wallet from the OCI Vault to the Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
importDeploymentWallet
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listCertificates
public Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)
Description copied from interface:GoldenGateAsync
Returns a list of certificates from truststore.- Specified by:
listCertificates
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listConnectionAssignments
public Future<ListConnectionAssignmentsResponse> listConnectionAssignments(ListConnectionAssignmentsRequest request, AsyncHandler<ListConnectionAssignmentsRequest,ListConnectionAssignmentsResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the Connection Assignments in the compartment.- Specified by:
listConnectionAssignments
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listConnections
public Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the Connections in the compartment.- Specified by:
listConnections
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDatabaseRegistrations
public Future<ListDatabaseRegistrationsResponse> listDatabaseRegistrations(ListDatabaseRegistrationsRequest request, AsyncHandler<ListDatabaseRegistrationsRequest,ListDatabaseRegistrationsResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
- Specified by:
listDatabaseRegistrations
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listDeploymentEnvironments
public Future<ListDeploymentEnvironmentsResponse> listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request, AsyncHandler<ListDeploymentEnvironmentsRequest,ListDeploymentEnvironmentsResponse> handler)
Description copied from interface:GoldenGateAsync
Returns an array of DeploymentEnvironmentDescriptor- Specified by:
listDeploymentEnvironments
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDeploymentPeers
public Future<ListDeploymentPeersResponse> listDeploymentPeers(ListDeploymentPeersRequest request, AsyncHandler<ListDeploymentPeersRequest,ListDeploymentPeersResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the local and remote peers in a deployment.- Specified by:
listDeploymentPeers
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDeploymentTypes
public Future<ListDeploymentTypesResponse> listDeploymentTypes(ListDeploymentTypesRequest request, AsyncHandler<ListDeploymentTypesRequest,ListDeploymentTypesResponse> handler)
Description copied from interface:GoldenGateAsync
Returns an array of DeploymentTypeDescriptor- Specified by:
listDeploymentTypes
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDeploymentVersions
public Future<ListDeploymentVersionsResponse> listDeploymentVersions(ListDeploymentVersionsRequest request, AsyncHandler<ListDeploymentVersionsRequest,ListDeploymentVersionsResponse> handler)
Description copied from interface:GoldenGateAsync
Returns the list of available deployment versions.- Specified by:
listDeploymentVersions
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDeploymentWalletsOperations
public Future<ListDeploymentWalletsOperationsResponse> listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request, AsyncHandler<ListDeploymentWalletsOperationsRequest,ListDeploymentWalletsOperationsResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the wallets export/import operations to/from a deployment.- Specified by:
listDeploymentWalletsOperations
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listMessages
public Future<ListMessagesResponse> listMessages(ListMessagesRequest request, AsyncHandler<ListMessagesRequest,ListMessagesResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the DeploymentMessages for a deployment.The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.
- Specified by:
listMessages
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listPipelineInitializationSteps
public Future<ListPipelineInitializationStepsResponse> listPipelineInitializationSteps(ListPipelineInitializationStepsRequest request, AsyncHandler<ListPipelineInitializationStepsRequest,ListPipelineInitializationStepsResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Pipeline recipe steps and its progress details.- Specified by:
listPipelineInitializationSteps
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listPipelineRunningProcesses
public Future<ListPipelineRunningProcessesResponse> listPipelineRunningProcesses(ListPipelineRunningProcessesRequest request, AsyncHandler<ListPipelineRunningProcessesRequest,ListPipelineRunningProcessesResponse> handler)
Description copied from interface:GoldenGateAsync
Retrieves a Pipeline’s running replication process’s status like Capture/Apply.- Specified by:
listPipelineRunningProcesses
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPipelineSchemaTables
public Future<ListPipelineSchemaTablesResponse> listPipelineSchemaTables(ListPipelineSchemaTablesRequest request, AsyncHandler<ListPipelineSchemaTablesRequest,ListPipelineSchemaTablesResponse> handler)
Description copied from interface:GoldenGateAsync
Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.- Specified by:
listPipelineSchemaTables
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPipelineSchemas
public Future<ListPipelineSchemasResponse> listPipelineSchemas(ListPipelineSchemasRequest request, AsyncHandler<ListPipelineSchemasRequest,ListPipelineSchemasResponse> handler)
Description copied from interface:GoldenGateAsync
Returns an array of schemas based on mapping rules for a pipeline.- Specified by:
listPipelineSchemas
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPipelines
public Future<ListPipelinesResponse> listPipelines(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the Pipelines in the compartment.- Specified by:
listPipelines
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listRecipes
public Future<ListRecipesResponse> listRecipes(ListRecipesRequest request, AsyncHandler<ListRecipesRequest,ListRecipesResponse> handler)
Description copied from interface:GoldenGateAsync
Returns an array of Recipe Summary.- Specified by:
listRecipes
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTrailFiles
public Future<ListTrailFilesResponse> listTrailFiles(ListTrailFilesRequest request, AsyncHandler<ListTrailFilesRequest,ListTrailFilesResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the TrailFiles for a deployment.Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
- Specified by:
listTrailFiles
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTrailSequences
public Future<ListTrailSequencesResponse> listTrailSequences(ListTrailSequencesRequest request, AsyncHandler<ListTrailSequencesRequest,ListTrailSequencesResponse> handler)
Description copied from interface:GoldenGateAsync
Lists the Trail Sequences for a TrailFile in a given deployment.Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
- Specified by:
listTrailSequences
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
refreshConnection
public Future<RefreshConnectionResponse> refreshConnection(RefreshConnectionRequest request, AsyncHandler<RefreshConnectionRequest,RefreshConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Refresh the external Connection attributes.- Specified by:
refreshConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeConnectionLock
public Future<RemoveConnectionLockResponse> removeConnectionLock(RemoveConnectionLockRequest request, AsyncHandler<RemoveConnectionLockRequest,RemoveConnectionLockResponse> handler)
Description copied from interface:GoldenGateAsync
Removes a lock from a Connection resource.- Specified by:
removeConnectionLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
removeDeploymentBackupLock
public Future<RemoveDeploymentBackupLockResponse> removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request, AsyncHandler<RemoveDeploymentBackupLockRequest,RemoveDeploymentBackupLockResponse> handler)
Description copied from interface:GoldenGateAsync
Removes a lock from a DeploymentBackup resource.- Specified by:
removeDeploymentBackupLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeDeploymentLocalPeer
public Future<RemoveDeploymentLocalPeerResponse> removeDeploymentLocalPeer(RemoveDeploymentLocalPeerRequest request, AsyncHandler<RemoveDeploymentLocalPeerRequest,RemoveDeploymentLocalPeerResponse> handler)
Description copied from interface:GoldenGateAsync
Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
removeDeploymentLocalPeer
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeDeploymentLock
public Future<RemoveDeploymentLockResponse> removeDeploymentLock(RemoveDeploymentLockRequest request, AsyncHandler<RemoveDeploymentLockRequest,RemoveDeploymentLockResponse> handler)
Description copied from interface:GoldenGateAsync
Removes a lock from a Deployment resource.- Specified by:
removeDeploymentLock
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
rescheduleDeploymentUpgrade
public Future<RescheduleDeploymentUpgradeResponse> rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request, AsyncHandler<RescheduleDeploymentUpgradeRequest,RescheduleDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
rescheduleDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
rollbackDeploymentUpgrade
public Future<RollbackDeploymentUpgradeResponse> rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request, AsyncHandler<RollbackDeploymentUpgradeRequest,RollbackDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Rollback a deployment to it’s previous version.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
rollbackDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
snoozeDeploymentUpgrade
public Future<SnoozeDeploymentUpgradeResponse> snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request, AsyncHandler<SnoozeDeploymentUpgradeRequest,SnoozeDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Snooze a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
snoozeDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
startPipeline
public Future<StartPipelineResponse> startPipeline(StartPipelineRequest request, AsyncHandler<StartPipelineRequest,StartPipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Starts the pipeline for data replication.- Specified by:
startPipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
stopPipeline
public Future<StopPipelineResponse> stopPipeline(StopPipelineRequest request, AsyncHandler<StopPipelineRequest,StopPipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Stops the pipeline for data replication.- Specified by:
stopPipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
switchoverDeploymentPeer
public Future<SwitchoverDeploymentPeerResponse> switchoverDeploymentPeer(SwitchoverDeploymentPeerRequest request, AsyncHandler<SwitchoverDeploymentPeerRequest,SwitchoverDeploymentPeerResponse> handler)
Description copied from interface:GoldenGateAsync
Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
switchoverDeploymentPeer
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
testConnectionAssignment
public Future<TestConnectionAssignmentResponse> testConnectionAssignment(TestConnectionAssignmentRequest request, AsyncHandler<TestConnectionAssignmentRequest,TestConnectionAssignmentResponse> handler)
Description copied from interface: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.
- Specified by:
testConnectionAssignment
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
testPipelineConnection
public Future<TestPipelineConnectionResponse> testPipelineConnection(TestPipelineConnectionRequest request, AsyncHandler<TestPipelineConnectionRequest,TestPipelineConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Tests pipeline connections against pipeline to verify the connectivity.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
testPipelineConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateConnection
public Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
Description copied from interface:GoldenGateAsync
Updates the Connection.- Specified by:
updateConnection
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateDatabaseRegistration
public Future<UpdateDatabaseRegistrationResponse> updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request, AsyncHandler<UpdateDatabaseRegistrationRequest,UpdateDatabaseRegistrationResponse> handler)
Description copied from interface:GoldenGateAsync
Note: Deprecated.Use the /connections API instead. Updates the DatabaseRegistration.
- Specified by:
updateDatabaseRegistration
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updatePipeline
public Future<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest request, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResponse> handler)
Description copied from interface:GoldenGateAsync
Updates the Pipeline.- Specified by:
updatePipeline
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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 interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
upgradeDeploymentUpgrade
public Future<UpgradeDeploymentUpgradeResponse> upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request, AsyncHandler<UpgradeDeploymentUpgradeRequest,UpgradeDeploymentUpgradeResponse> handler)
Description copied from interface:GoldenGateAsync
Upgrade a deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
upgradeDeploymentUpgrade
in interfaceGoldenGateAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-