Get the endpoint that is being used to call (ex, https://www.example.com).
Sets the endpoint to call (ex, https://www.example.com).
The endpoint of the service.
Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
The region of the service.
Sets the regionId to call (ex, 'us-phoenix-1').
Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.
The public region ID.
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
flag to enable the use of realm specific endpoint template
Adds a lock to a Connection resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
AddConnectionLockResponse
Adds a lock to a DeploymentBackup resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
AddDeploymentBackupLockResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
AddDeploymentLocalPeerResponse
Adds a lock to a Deployment resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
AddDeploymentLockResponse
Cancels a Deployment Backup creation process. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CancelDeploymentBackupResponse
Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CancelDeploymentUpgradeResponse
Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CancelSnoozeDeploymentUpgradeResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeConnectionCompartmentResponse
Associate a GoldanGate connection with a different subscription.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeConnectionSubscriptionResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeDatabaseRegistrationCompartmentResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeDeploymentBackupCompartmentResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeDeploymentCompartmentResponse
Associate a GoldanGate deployment with a different subscription.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangeDeploymentSubscriptionResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ChangePipelineCompartmentResponse
Close the client once it is no longer needed
Close the provider if possible which in turn shuts down any associated circuit breaker
Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CollectDeploymentDiagnosticResponse
Collects diagnostics for the pipeline
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CollectPipelineDiagnosticResponse
Creates a copy of a Deployment Backup. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CopyDeploymentBackupResponse
Creates a new certificate to truststore.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateCertificateResponse
Creates a new Connection.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateConnectionResponse
Creates a new Connection Assignment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateConnectionAssignmentResponse
Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateDatabaseRegistrationResponse
Creates a new Deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateDeploymentResponse
Creates a new DeploymentBackup. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreateDeploymentBackupResponse
Creates a new Pipeline.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
CreatePipelineResponse
Creates a new GoldenGateWaiter for resources for this service.
The waiter configuration for termination and delay strategy
The service waiters.
Deletes the certificate from truststore.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteCertificateResponse
Deletes a Connection.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteConnectionResponse
Deletes a Connection Assignment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteConnectionAssignmentResponse
Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteDatabaseRegistrationResponse
Deletes the Deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteDeploymentResponse
Deletes a DeploymentBackup.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeleteDeploymentBackupResponse
Deletes a Pipeline.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeletePipelineResponse
Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
DeploymentWalletExistsResponse
Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ExportDeploymentWalletResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GenerateLibraryUrlResponse
Retrieves a Certificate.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetCertificateResponse
Retrieves a Connection.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetConnectionResponse
Retrieves a Connection Assignment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetConnectionAssignmentResponse
Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetDatabaseRegistrationResponse
Retrieves a deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetDeploymentResponse
Retrieves a DeploymentBackup.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetDeploymentBackupResponse
Retrieves a deployment upgrade.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetDeploymentUpgradeResponse
Retrieves a Pipeline details.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetPipelineResponse
Gets the waiters available for resources for this service.
The service waiters.
Retrieve the WorkRequest identified by the given OCID.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
GetWorkRequestResponse
Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ImportDeploymentWalletResponse
NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Returns a list of certificates from truststore. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListCertificatesResponse
Lists the Connection Assignments in the compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListConnectionAssignmentsResponse
Lists the Connections in the compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListConnectionsResponse
Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDatabaseRegistrationsResponse
Lists the Backups in a compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentBackupsResponse
Returns an array of DeploymentEnvironmentDescriptor
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentEnvironmentsResponse
Lists the local and remote peers in a deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentPeersResponse
Returns an array of DeploymentTypeDescriptor
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentTypesResponse
Lists the Deployment Upgrades in a compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentUpgradesResponse
Returns the list of available deployment versions.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentVersionsResponse
Lists the wallets export/import operations to/from a deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentWalletsOperationsResponse
Lists the Deployments in a compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListDeploymentsResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListMessagesResponse
Retrieves a Pipeline recipe steps and its progress details.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListPipelineInitializationStepsResponse
Retrieves a Pipeline's running replication process's status like Capture/Apply.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListPipelineRunningProcessesResponse
Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListPipelineSchemaTablesResponse
Returns an array of schemas based on mapping rules for a pipeline.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListPipelineSchemasResponse
Lists the Pipelines in the compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListPipelinesResponse
Returns an array of Recipe Summary.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListRecipesResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListTrailFilesResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListTrailSequencesResponse
Lists work request errors.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListWorkRequestErrorsResponse
Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists work request logs.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListWorkRequestLogsResponse
Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the work requests in the compartment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
ListWorkRequestsResponse
Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Refresh the external Connection attributes.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RefreshConnectionResponse
Removes a lock from a Connection resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RemoveConnectionLockResponse
Removes a lock from a DeploymentBackup resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RemoveDeploymentBackupLockResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RemoveDeploymentLocalPeerResponse
Removes a lock from a Deployment resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RemoveDeploymentLockResponse
Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RescheduleDeploymentUpgradeResponse
Restores a Deployment from a Deployment Backup created from the same Deployment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RestoreDeploymentResponse
Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
RollbackDeploymentUpgradeResponse
Shutdown the circuit breaker used by the client when it is no longer needed
Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
SnoozeDeploymentUpgradeResponse
Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
StartDeploymentResponse
Starts the pipeline for data replication.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
StartPipelineResponse
Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
StopDeploymentResponse
Stops the pipeline for data replication.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
StopPipelineResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
SwitchoverDeploymentPeerResponse
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.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
TestConnectionAssignmentResponse
Tests pipeline connections against pipeline to verify the connectivity. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
TestPipelineConnectionResponse
Updates the Connection.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpdateConnectionResponse
Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpdateDatabaseRegistrationResponse
Modifies a Deployment.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpdateDeploymentResponse
Modifies a Deployment Backup.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpdateDeploymentBackupResponse
Updates the Pipeline.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpdatePipelineResponse
Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpgradeDeploymentResponse
Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.
This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
UpgradeDeploymentUpgradeResponse
This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.