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 GoldenGateAsyncAsync 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 classGoldenGateAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for GoldenGate.
-
Constructor Summary
Constructors Constructor Description GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.GoldenGateAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
GoldenGateAsyncClient
@Deprecated public GoldenGateAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGoldenGateAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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:GoldenGateAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceGoldenGateAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:GoldenGateAsyncSets 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:
setRegionin interfaceGoldenGateAsync- Parameters:
regionId- The public region ID.
-
addConnectionLock
public Future<AddConnectionLockResponse> addConnectionLock(AddConnectionLockRequest request, AsyncHandler<AddConnectionLockRequest,AddConnectionLockResponse> handler)
Description copied from interface:GoldenGateAsyncAdds a lock to a Connection resource.- Specified by:
addConnectionLockin 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:GoldenGateAsyncAdds a lock to a DeploymentBackup resource.- Specified by:
addDeploymentBackupLockin 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:GoldenGateAsyncAdds 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:
addDeploymentLocalPeerin 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:GoldenGateAsyncAdds a lock to a Deployment resource.- Specified by:
addDeploymentLockin 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:GoldenGateAsyncCancels a Deployment Backup creation process.- Specified by:
cancelDeploymentBackupin 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:GoldenGateAsyncCancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
cancelDeploymentUpgradein 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:GoldenGateAsyncCancel snooze of a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
cancelSnoozeDeploymentUpgradein 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:GoldenGateAsyncMoves 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:
changeConnectionCompartmentin 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.
-
changeConnectionSubscription
public Future<ChangeConnectionSubscriptionResponse> changeConnectionSubscription(ChangeConnectionSubscriptionRequest request, AsyncHandler<ChangeConnectionSubscriptionRequest,ChangeConnectionSubscriptionResponse> handler)
Description copied from interface:GoldenGateAsyncAssociate a GoldanGate connection with a different subscription.- Specified by:
changeConnectionSubscriptionin 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:GoldenGateAsyncNote: 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:
changeDatabaseRegistrationCompartmentin 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:GoldenGateAsyncMoves 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:
changeDeploymentBackupCompartmentin 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:GoldenGateAsyncMoves 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:
changeDeploymentCompartmentin 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.
-
changeDeploymentSubscription
public Future<ChangeDeploymentSubscriptionResponse> changeDeploymentSubscription(ChangeDeploymentSubscriptionRequest request, AsyncHandler<ChangeDeploymentSubscriptionRequest,ChangeDeploymentSubscriptionResponse> handler)
Description copied from interface:GoldenGateAsyncAssociate a GoldanGate deployment with a different subscription.- Specified by:
changeDeploymentSubscriptionin 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:GoldenGateAsyncMoves 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:
changePipelineCompartmentin 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:GoldenGateAsyncCollects the diagnostic of a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
collectDeploymentDiagnosticin 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:GoldenGateAsyncCollects diagnostics for the pipeline- Specified by:
collectPipelineDiagnosticin 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:GoldenGateAsyncCreates a copy of a Deployment Backup.- Specified by:
copyDeploymentBackupin 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:GoldenGateAsyncCreates a new certificate to truststore.- Specified by:
createCertificatein 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:GoldenGateAsyncCreates a new Connection.- Specified by:
createConnectionin 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:GoldenGateAsyncCreates a new Connection Assignment.- Specified by:
createConnectionAssignmentin 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:GoldenGateAsyncNote: Deprecated.Use the /connections API instead. Creates a new DatabaseRegistration.
- Specified by:
createDatabaseRegistrationin 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:GoldenGateAsyncCreates a new Deployment.- Specified by:
createDeploymentin 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:GoldenGateAsyncCreates a new DeploymentBackup.- Specified by:
createDeploymentBackupin 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:GoldenGateAsyncCreates a new Pipeline.- Specified by:
createPipelinein 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:GoldenGateAsyncDeletes the certificate from truststore.- Specified by:
deleteCertificatein 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:GoldenGateAsyncDeletes a Connection.- Specified by:
deleteConnectionin 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:GoldenGateAsyncDeletes a Connection Assignment.- Specified by:
deleteConnectionAssignmentin 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:GoldenGateAsyncNote: Deprecated.Use the /connections API instead. Deletes a DatabaseRegistration.
- Specified by:
deleteDatabaseRegistrationin 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:GoldenGateAsyncDeletes the Deployment.- Specified by:
deleteDeploymentin 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:GoldenGateAsyncDeletes a DeploymentBackup.- Specified by:
deleteDeploymentBackupin 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:GoldenGateAsyncDeletes a Pipeline.- Specified by:
deletePipelinein 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:GoldenGateAsyncChecks if a wallet is already present in the deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
deploymentWalletExistsin 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:GoldenGateAsyncExport the OGG wallet from the deployment to OCI vault.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
exportDeploymentWalletin 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:GoldenGateAsyncGenerates 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:
generateLibraryUrlin 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:GoldenGateAsyncRetrieves a Certificate.- Specified by:
getCertificatein 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:GoldenGateAsyncRetrieves a Connection.- Specified by:
getConnectionin 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:GoldenGateAsyncRetrieves a Connection Assignment.- Specified by:
getConnectionAssignmentin 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:GoldenGateAsyncNote: Deprecated.Use the /connections API instead. Retrieves a DatabaseRegistration.
- Specified by:
getDatabaseRegistrationin 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:GoldenGateAsyncRetrieves a deployment.- Specified by:
getDeploymentin 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:GoldenGateAsyncRetrieves a DeploymentBackup.- Specified by:
getDeploymentBackupin 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:GoldenGateAsyncRetrieves a deployment upgrade.- Specified by:
getDeploymentUpgradein 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:GoldenGateAsyncRetrieves a Pipeline details.- Specified by:
getPipelinein 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:GoldenGateAsyncRetrieve the WorkRequest identified by the given OCID.- Specified by:
getWorkRequestin 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:GoldenGateAsyncImports an OGG wallet from the OCI Vault to the Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
importDeploymentWalletin 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:GoldenGateAsyncReturns a list of certificates from truststore.- Specified by:
listCertificatesin 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:GoldenGateAsyncLists the Connection Assignments in the compartment.- Specified by:
listConnectionAssignmentsin 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:GoldenGateAsyncLists the Connections in the compartment.- Specified by:
listConnectionsin 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:GoldenGateAsyncNote: Deprecated.Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
- Specified by:
listDatabaseRegistrationsin 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:GoldenGateAsyncLists the Backups in a compartment.- Specified by:
listDeploymentBackupsin 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:GoldenGateAsyncReturns an array of DeploymentEnvironmentDescriptor- Specified by:
listDeploymentEnvironmentsin 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:GoldenGateAsyncLists the local and remote peers in a deployment.- Specified by:
listDeploymentPeersin 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:GoldenGateAsyncReturns an array of DeploymentTypeDescriptor- Specified by:
listDeploymentTypesin 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:GoldenGateAsyncLists the Deployment Upgrades in a compartment.- Specified by:
listDeploymentUpgradesin 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:GoldenGateAsyncReturns the list of available deployment versions.- Specified by:
listDeploymentVersionsin 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:GoldenGateAsyncLists the wallets export/import operations to/from a deployment.- Specified by:
listDeploymentWalletsOperationsin 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:GoldenGateAsyncLists the Deployments in a compartment.- Specified by:
listDeploymentsin 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:GoldenGateAsyncLists 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:
listMessagesin 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:GoldenGateAsyncRetrieves a Pipeline recipe steps and its progress details.- Specified by:
listPipelineInitializationStepsin 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:GoldenGateAsyncRetrieves a Pipeline’s running replication process’s status like Capture/Apply.- Specified by:
listPipelineRunningProcessesin 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:GoldenGateAsyncReturns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.- Specified by:
listPipelineSchemaTablesin 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:GoldenGateAsyncReturns an array of schemas based on mapping rules for a pipeline.- Specified by:
listPipelineSchemasin 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:GoldenGateAsyncLists the Pipelines in the compartment.- Specified by:
listPipelinesin 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:GoldenGateAsyncReturns an array of Recipe Summary.- Specified by:
listRecipesin 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:GoldenGateAsyncLists 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:
listTrailFilesin 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:GoldenGateAsyncLists 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:
listTrailSequencesin 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:GoldenGateAsyncLists work request errors.- Specified by:
listWorkRequestErrorsin 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:GoldenGateAsyncLists work request logs.- Specified by:
listWorkRequestLogsin 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:GoldenGateAsyncLists the work requests in the compartment.- Specified by:
listWorkRequestsin 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:GoldenGateAsyncRefresh the external Connection attributes.- Specified by:
refreshConnectionin 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:GoldenGateAsyncRemoves a lock from a Connection resource.- Specified by:
removeConnectionLockin 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:GoldenGateAsyncRemoves a lock from a DeploymentBackup resource.- Specified by:
removeDeploymentBackupLockin 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:GoldenGateAsyncRemoves 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:
removeDeploymentLocalPeerin 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:GoldenGateAsyncRemoves a lock from a Deployment resource.- Specified by:
removeDeploymentLockin 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:GoldenGateAsyncReschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
rescheduleDeploymentUpgradein 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:GoldenGateAsyncRestores a Deployment from a Deployment Backup created from the same Deployment.- Specified by:
restoreDeploymentin 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:GoldenGateAsyncRollback a deployment to it’s previous version.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
rollbackDeploymentUpgradein 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:GoldenGateAsyncSnooze a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
snoozeDeploymentUpgradein 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:GoldenGateAsyncStarts a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
startDeploymentin 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:GoldenGateAsyncStarts the pipeline for data replication.- Specified by:
startPipelinein 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:GoldenGateAsyncStops a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
stopDeploymentin 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:GoldenGateAsyncStops the pipeline for data replication.- Specified by:
stopPipelinein 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:GoldenGateAsyncSwitchover 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:
switchoverDeploymentPeerin 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:GoldenGateAsyncTests 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:
testConnectionAssignmentin 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:GoldenGateAsyncTests pipeline connections against pipeline to verify the connectivity.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
testPipelineConnectionin 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:GoldenGateAsyncUpdates the Connection.- Specified by:
updateConnectionin 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:GoldenGateAsyncNote: Deprecated.Use the /connections API instead. Updates the DatabaseRegistration.
- Specified by:
updateDatabaseRegistrationin 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:GoldenGateAsyncModifies a Deployment.- Specified by:
updateDeploymentin 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:GoldenGateAsyncModifies a Deployment Backup.- Specified by:
updateDeploymentBackupin 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:GoldenGateAsyncUpdates the Pipeline.- Specified by:
updatePipelinein 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:GoldenGateAsyncUpgrade a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
upgradeDeploymentin 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:GoldenGateAsyncUpgrade a deployment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
upgradeDeploymentUpgradein 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
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein 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)
-
-