GoldenGate (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

GoldenGateClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public interface GoldenGate
extends AutoCloseable
```
Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddConnectionLockResponse`	`addConnectionLock(AddConnectionLockRequest request)` Adds a lock to a Connection resource.
`AddDeploymentBackupLockResponse`	`addDeploymentBackupLock(AddDeploymentBackupLockRequest request)` Adds a lock to a DeploymentBackup resource.
`AddDeploymentLockResponse`	`addDeploymentLock(AddDeploymentLockRequest request)` Adds a lock to a Deployment resource.
`CancelDeploymentBackupResponse`	`cancelDeploymentBackup(CancelDeploymentBackupRequest request)` Cancels a Deployment Backup creation process.
`CancelDeploymentUpgradeResponse`	`cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request)` Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
`CancelSnoozeDeploymentUpgradeResponse`	`cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request)` Cancel snooze of a DeploymentUpgrade.
`ChangeConnectionCompartmentResponse`	`changeConnectionCompartment(ChangeConnectionCompartmentRequest request)` Moves the Connection into a different compartment within the same tenancy.
`ChangeDatabaseRegistrationCompartmentResponse`	`changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)` Note: Deprecated.
`ChangeDeploymentBackupCompartmentResponse`	`changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request)` Moves a DeploymentBackup into a different compartment within the same tenancy.
`ChangeDeploymentCompartmentResponse`	`changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)` Moves the Deployment into a different compartment within the same tenancy.
`CollectDeploymentDiagnosticResponse`	`collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request)` Collects the diagnostic of a Deployment.
`CopyDeploymentBackupResponse`	`copyDeploymentBackup(CopyDeploymentBackupRequest request)` Creates a copy of a Deployment Backup.
`CreateCertificateResponse`	`createCertificate(CreateCertificateRequest request)` Creates a new certificate to truststore.
`CreateConnectionResponse`	`createConnection(CreateConnectionRequest request)` Creates a new Connection.
`CreateConnectionAssignmentResponse`	`createConnectionAssignment(CreateConnectionAssignmentRequest request)` Creates a new Connection Assignment.
`CreateDatabaseRegistrationResponse`	`createDatabaseRegistration(CreateDatabaseRegistrationRequest request)` Note: Deprecated.
`CreateDeploymentResponse`	`createDeployment(CreateDeploymentRequest request)` Creates a new Deployment.
`CreateDeploymentBackupResponse`	`createDeploymentBackup(CreateDeploymentBackupRequest request)` Creates a new DeploymentBackup.
`DeleteCertificateResponse`	`deleteCertificate(DeleteCertificateRequest request)` Deletes the certificate from truststore.
`DeleteConnectionResponse`	`deleteConnection(DeleteConnectionRequest request)` Deletes a Connection.
`DeleteConnectionAssignmentResponse`	`deleteConnectionAssignment(DeleteConnectionAssignmentRequest request)` Deletes a Connection Assignment.
`DeleteDatabaseRegistrationResponse`	`deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)` Note: Deprecated.
`DeleteDeploymentResponse`	`deleteDeployment(DeleteDeploymentRequest request)` Deletes the Deployment.
`DeleteDeploymentBackupResponse`	`deleteDeploymentBackup(DeleteDeploymentBackupRequest request)` Deletes a DeploymentBackup.
`DeploymentWalletExistsResponse`	`deploymentWalletExists(DeploymentWalletExistsRequest request)` Checks if a wallet is already present in the deployment.
`ExportDeploymentWalletResponse`	`exportDeploymentWallet(ExportDeploymentWalletRequest request)` Export the OGG wallet from the deployment to OCI vault.
`GenerateLibraryUrlResponse`	`generateLibraryUrl(GenerateLibraryUrlRequest request)` 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.
`GetCertificateResponse`	`getCertificate(GetCertificateRequest request)` Retrieves a Certificate.
`GetConnectionResponse`	`getConnection(GetConnectionRequest request)` Retrieves a Connection.
`GetConnectionAssignmentResponse`	`getConnectionAssignment(GetConnectionAssignmentRequest request)` Retrieves a Connection Assignment.
`GetDatabaseRegistrationResponse`	`getDatabaseRegistration(GetDatabaseRegistrationRequest request)` Note: Deprecated.
`GetDeploymentResponse`	`getDeployment(GetDeploymentRequest request)` Retrieves a deployment.
`GetDeploymentBackupResponse`	`getDeploymentBackup(GetDeploymentBackupRequest request)` Retrieves a DeploymentBackup.
`GetDeploymentUpgradeResponse`	`getDeploymentUpgrade(GetDeploymentUpgradeRequest request)` Retrieves a deployment upgrade.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GoldenGatePaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GoldenGateWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Retrieve the WorkRequest identified by the given OCID.
`ImportDeploymentWalletResponse`	`importDeploymentWallet(ImportDeploymentWalletRequest request)` Imports an OGG wallet from the OCI Vault to the Deployment.
`ListCertificatesResponse`	`listCertificates(ListCertificatesRequest request)` Returns a list of certificates from truststore.
`ListConnectionAssignmentsResponse`	`listConnectionAssignments(ListConnectionAssignmentsRequest request)` Lists the Connection Assignments in the compartment.
`ListConnectionsResponse`	`listConnections(ListConnectionsRequest request)` Lists the Connections in the compartment.
`ListDatabaseRegistrationsResponse`	`listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)` Note: Deprecated.
`ListDeploymentBackupsResponse`	`listDeploymentBackups(ListDeploymentBackupsRequest request)` Lists the Backups in a compartment.
`ListDeploymentEnvironmentsResponse`	`listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request)` Returns an array of DeploymentEnvironmentDescriptor
`ListDeploymentsResponse`	`listDeployments(ListDeploymentsRequest request)` Lists the Deployments in a compartment.
`ListDeploymentTypesResponse`	`listDeploymentTypes(ListDeploymentTypesRequest request)` Returns an array of DeploymentTypeDescriptor
`ListDeploymentUpgradesResponse`	`listDeploymentUpgrades(ListDeploymentUpgradesRequest request)` Lists the Deployment Upgrades in a compartment.
`ListDeploymentVersionsResponse`	`listDeploymentVersions(ListDeploymentVersionsRequest request)` Returns the list of available deployment versions.
`ListDeploymentWalletsOperationsResponse`	`listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request)` Lists the wallets export/import operations to/from a deployment.
`ListMessagesResponse`	`listMessages(ListMessagesRequest request)` Lists the DeploymentMessages for a deployment.
`ListTrailFilesResponse`	`listTrailFiles(ListTrailFilesRequest request)` Lists the TrailFiles for a deployment.
`ListTrailSequencesResponse`	`listTrailSequences(ListTrailSequencesRequest request)` Lists the Trail Sequences for a TrailFile in a given deployment.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Lists work request errors.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Lists work request logs.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in the compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RemoveConnectionLockResponse`	`removeConnectionLock(RemoveConnectionLockRequest request)` Removes a lock from a Connection resource.
`RemoveDeploymentBackupLockResponse`	`removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request)` Removes a lock from a DeploymentBackup resource.
`RemoveDeploymentLockResponse`	`removeDeploymentLock(RemoveDeploymentLockRequest request)` Removes a lock from a Deployment resource.
`RescheduleDeploymentUpgradeResponse`	`rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request)` Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
`RestoreDeploymentResponse`	`restoreDeployment(RestoreDeploymentRequest request)` Restores a Deployment from a Deployment Backup created from the same Deployment.
`RollbackDeploymentUpgradeResponse`	`rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request)` Rollback a deployment to it’s previous version.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`SnoozeDeploymentUpgradeResponse`	`snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request)` Snooze a DeploymentUpgrade.
`StartDeploymentResponse`	`startDeployment(StartDeploymentRequest request)` Starts a Deployment.
`StopDeploymentResponse`	`stopDeployment(StopDeploymentRequest request)` Stops a Deployment.
`TestConnectionAssignmentResponse`	`testConnectionAssignment(TestConnectionAssignmentRequest request)` Tests the connectivity between given GoldenGate deployment and one of the associated database / service.
`UpdateConnectionResponse`	`updateConnection(UpdateConnectionRequest request)` Updates the Connection.
`UpdateDatabaseRegistrationResponse`	`updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)` Note: Deprecated.
`UpdateDeploymentResponse`	`updateDeployment(UpdateDeploymentRequest request)` Modifies a Deployment.
`UpdateDeploymentBackupResponse`	`updateDeploymentBackup(UpdateDeploymentBackupRequest request)` Modifies a Deployment Backup.
`UpgradeDeploymentResponse`	`upgradeDeployment(UpgradeDeploymentRequest request)` Upgrade a Deployment.
`UpgradeDeploymentUpgradeResponse`	`upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request)` Upgrade a deployment.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    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”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - addConnectionLock
```
AddConnectionLockResponse addConnectionLock(AddConnectionLockRequest request)
```
    Adds a lock to a Connection resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddConnectionLock API.
  - addDeploymentBackupLock
```
AddDeploymentBackupLockResponse addDeploymentBackupLock(AddDeploymentBackupLockRequest request)
```
    Adds a lock to a DeploymentBackup resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddDeploymentBackupLock API.
  - addDeploymentLock
```
AddDeploymentLockResponse addDeploymentLock(AddDeploymentLockRequest request)
```
    Adds a lock to a Deployment resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AddDeploymentLock API.
  - cancelDeploymentBackup
```
CancelDeploymentBackupResponse cancelDeploymentBackup(CancelDeploymentBackupRequest request)
```
    Cancels a Deployment Backup creation process.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelDeploymentBackup API.
  - cancelDeploymentUpgrade
```
CancelDeploymentUpgradeResponse cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request)
```
    Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelDeploymentUpgrade API.
  - cancelSnoozeDeploymentUpgrade
```
CancelSnoozeDeploymentUpgradeResponse cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request)
```
    Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelSnoozeDeploymentUpgrade API.
  - changeConnectionCompartment
```
ChangeConnectionCompartmentResponse changeConnectionCompartment(ChangeConnectionCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeConnectionCompartment API.
  - changeDatabaseRegistrationCompartment
```
ChangeDatabaseRegistrationCompartmentResponse changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeDatabaseRegistrationCompartment API.
  - changeDeploymentBackupCompartment
```
ChangeDeploymentBackupCompartmentResponse changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeDeploymentBackupCompartment API.
  - changeDeploymentCompartment
```
ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeDeploymentCompartment API.
  - collectDeploymentDiagnostic
```
CollectDeploymentDiagnosticResponse collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request)
```
    Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CollectDeploymentDiagnostic API.
  - copyDeploymentBackup
```
CopyDeploymentBackupResponse copyDeploymentBackup(CopyDeploymentBackupRequest request)
```
    Creates a copy of a Deployment Backup.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CopyDeploymentBackup API.
  - createCertificate
```
CreateCertificateResponse createCertificate(CreateCertificateRequest request)
```
    Creates a new certificate to truststore.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCertificate API.
  - createConnection
```
CreateConnectionResponse createConnection(CreateConnectionRequest request)
```
    Creates a new Connection.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateConnection API.
  - createConnectionAssignment
```
CreateConnectionAssignmentResponse createConnectionAssignment(CreateConnectionAssignmentRequest request)
```
    Creates a new Connection Assignment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateConnectionAssignment API.
  - createDatabaseRegistration
```
CreateDatabaseRegistrationResponse createDatabaseRegistration(CreateDatabaseRegistrationRequest request)
```
    Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateDatabaseRegistration API.
  - createDeployment
```
CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)
```
    Creates a new Deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateDeployment API.
  - createDeploymentBackup
```
CreateDeploymentBackupResponse createDeploymentBackup(CreateDeploymentBackupRequest request)
```
    Creates a new DeploymentBackup.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateDeploymentBackup API.
  - deleteCertificate
```
DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
```
    Deletes the certificate from truststore.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCertificate API.
  - deleteConnection
```
DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
```
    Deletes a Connection.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteConnection API.
  - deleteConnectionAssignment
```
DeleteConnectionAssignmentResponse deleteConnectionAssignment(DeleteConnectionAssignmentRequest request)
```
    Deletes a Connection Assignment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteConnectionAssignment API.
  - deleteDatabaseRegistration
```
DeleteDatabaseRegistrationResponse deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)
```
    Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteDatabaseRegistration API.
  - deleteDeployment
```
DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)
```
    Deletes the Deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteDeployment API.
  - deleteDeploymentBackup
```
DeleteDeploymentBackupResponse deleteDeploymentBackup(DeleteDeploymentBackupRequest request)
```
    Deletes a DeploymentBackup.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteDeploymentBackup API.
  - deploymentWalletExists
```
DeploymentWalletExistsResponse deploymentWalletExists(DeploymentWalletExistsRequest request)
```
    Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeploymentWalletExists API.
  - exportDeploymentWallet
```
ExportDeploymentWalletResponse exportDeploymentWallet(ExportDeploymentWalletRequest request)
```
    Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ExportDeploymentWallet API.
  - generateLibraryUrl
```
GenerateLibraryUrlResponse generateLibraryUrl(GenerateLibraryUrlRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GenerateLibraryUrl API.
  - getCertificate
```
GetCertificateResponse getCertificate(GetCertificateRequest request)
```
    Retrieves a Certificate.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCertificate API.
  - getConnection
```
GetConnectionResponse getConnection(GetConnectionRequest request)
```
    Retrieves a Connection.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetConnection API.
  - getConnectionAssignment
```
GetConnectionAssignmentResponse getConnectionAssignment(GetConnectionAssignmentRequest request)
```
    Retrieves a Connection Assignment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetConnectionAssignment API.
  - getDatabaseRegistration
```
GetDatabaseRegistrationResponse getDatabaseRegistration(GetDatabaseRegistrationRequest request)
```
    Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDatabaseRegistration API.
  - getDeployment
```
GetDeploymentResponse getDeployment(GetDeploymentRequest request)
```
    Retrieves a deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDeployment API.
  - getDeploymentBackup
```
GetDeploymentBackupResponse getDeploymentBackup(GetDeploymentBackupRequest request)
```
    Retrieves a DeploymentBackup.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDeploymentBackup API.
  - getDeploymentUpgrade
```
GetDeploymentUpgradeResponse getDeploymentUpgrade(GetDeploymentUpgradeRequest request)
```
    Retrieves a deployment upgrade.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDeploymentUpgrade API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Retrieve the WorkRequest identified by the given OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - importDeploymentWallet
```
ImportDeploymentWalletResponse importDeploymentWallet(ImportDeploymentWalletRequest request)
```
    Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ImportDeploymentWallet API.
  - listCertificates
```
ListCertificatesResponse listCertificates(ListCertificatesRequest request)
```
    Returns a list of certificates from truststore.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListCertificates API.
  - listConnectionAssignments
```
ListConnectionAssignmentsResponse listConnectionAssignments(ListConnectionAssignmentsRequest request)
```
    Lists the Connection Assignments in the compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListConnectionAssignments API.
  - listConnections
```
ListConnectionsResponse listConnections(ListConnectionsRequest request)
```
    Lists the Connections in the compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListConnections API.
  - listDatabaseRegistrations
```
ListDatabaseRegistrationsResponse listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)
```
    Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDatabaseRegistrations API.
  - listDeploymentBackups
```
ListDeploymentBackupsResponse listDeploymentBackups(ListDeploymentBackupsRequest request)
```
    Lists the Backups in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentBackups API.
  - listDeploymentEnvironments
```
ListDeploymentEnvironmentsResponse listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request)
```
    Returns an array of DeploymentEnvironmentDescriptor
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentEnvironments API.
  - listDeploymentTypes
```
ListDeploymentTypesResponse listDeploymentTypes(ListDeploymentTypesRequest request)
```
    Returns an array of DeploymentTypeDescriptor
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentTypes API.
  - listDeploymentUpgrades
```
ListDeploymentUpgradesResponse listDeploymentUpgrades(ListDeploymentUpgradesRequest request)
```
    Lists the Deployment Upgrades in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentUpgrades API.
  - listDeploymentVersions
```
ListDeploymentVersionsResponse listDeploymentVersions(ListDeploymentVersionsRequest request)
```
    Returns the list of available deployment versions.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentVersions API.
  - listDeploymentWalletsOperations
```
ListDeploymentWalletsOperationsResponse listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request)
```
    Lists the wallets export/import operations to/from a deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeploymentWalletsOperations API.
  - listDeployments
```
ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)
```
    Lists the Deployments in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDeployments API.
  - listMessages
```
ListMessagesResponse listMessages(ListMessagesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListMessages API.
  - listTrailFiles
```
ListTrailFilesResponse listTrailFiles(ListTrailFilesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTrailFiles API.
  - listTrailSequences
```
ListTrailSequencesResponse listTrailSequences(ListTrailSequencesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTrailSequences API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Lists work request errors.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Lists work request logs.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the work requests in the compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - removeConnectionLock
```
RemoveConnectionLockResponse removeConnectionLock(RemoveConnectionLockRequest request)
```
    Removes a lock from a Connection resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveConnectionLock API.
  - removeDeploymentBackupLock
```
RemoveDeploymentBackupLockResponse removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request)
```
    Removes a lock from a DeploymentBackup resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveDeploymentBackupLock API.
  - removeDeploymentLock
```
RemoveDeploymentLockResponse removeDeploymentLock(RemoveDeploymentLockRequest request)
```
    Removes a lock from a Deployment resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RemoveDeploymentLock API.
  - rescheduleDeploymentUpgrade
```
RescheduleDeploymentUpgradeResponse rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request)
```
    Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RescheduleDeploymentUpgrade API.
  - restoreDeployment
```
RestoreDeploymentResponse restoreDeployment(RestoreDeploymentRequest request)
```
    Restores a Deployment from a Deployment Backup created from the same Deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RestoreDeployment API.
  - rollbackDeploymentUpgrade
```
RollbackDeploymentUpgradeResponse rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request)
```
    Rollback a deployment to it’s previous version. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RollbackDeploymentUpgrade API.
  - snoozeDeploymentUpgrade
```
SnoozeDeploymentUpgradeResponse snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request)
```
    Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use SnoozeDeploymentUpgrade API.
  - startDeployment
```
StartDeploymentResponse startDeployment(StartDeploymentRequest request)
```
    Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use StartDeployment API.
  - stopDeployment
```
StopDeploymentResponse stopDeployment(StopDeploymentRequest request)
```
    Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use StopDeployment API.
  - testConnectionAssignment
```
TestConnectionAssignmentResponse testConnectionAssignment(TestConnectionAssignmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use TestConnectionAssignment API.
  - updateConnection
```
UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
```
    Updates the Connection.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateConnection API.
  - updateDatabaseRegistration
```
UpdateDatabaseRegistrationResponse updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)
```
    Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateDatabaseRegistration API.
  - updateDeployment
```
UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)
```
    Modifies a Deployment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateDeployment API.
  - updateDeploymentBackup
```
UpdateDeploymentBackupResponse updateDeploymentBackup(UpdateDeploymentBackupRequest request)
```
    Modifies a Deployment Backup.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateDeploymentBackup API.
  - upgradeDeployment
```
UpgradeDeploymentResponse upgradeDeployment(UpgradeDeploymentRequest request)
```
    Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpgradeDeployment API.
  - upgradeDeploymentUpgrade
```
UpgradeDeploymentUpgradeResponse upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request)
```
    Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpgradeDeploymentUpgrade API.
  - getWaiters
```
GoldenGateWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
GoldenGatePaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface GoldenGate

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

addConnectionLock

addDeploymentBackupLock

addDeploymentLock

cancelDeploymentBackup

cancelDeploymentUpgrade

cancelSnoozeDeploymentUpgrade

changeConnectionCompartment

changeDatabaseRegistrationCompartment

changeDeploymentBackupCompartment

changeDeploymentCompartment

collectDeploymentDiagnostic

copyDeploymentBackup

createCertificate

createConnection

createConnectionAssignment

createDatabaseRegistration

createDeployment

createDeploymentBackup

deleteCertificate

deleteConnection

deleteConnectionAssignment

deleteDatabaseRegistration

deleteDeployment

deleteDeploymentBackup

deploymentWalletExists

exportDeploymentWallet

generateLibraryUrl

getCertificate

getConnection

getConnectionAssignment

getDatabaseRegistration

getDeployment

getDeploymentBackup

getDeploymentUpgrade

getWorkRequest

importDeploymentWallet

listCertificates

listConnectionAssignments

listConnections

listDatabaseRegistrations

listDeploymentBackups

listDeploymentEnvironments

listDeploymentTypes

listDeploymentUpgrades

listDeploymentVersions

listDeploymentWalletsOperations

listDeployments

listMessages

listTrailFiles

listTrailSequences

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

removeConnectionLock

removeDeploymentBackupLock

removeDeploymentLock

rescheduleDeploymentUpgrade

restoreDeployment

rollbackDeploymentUpgrade

snoozeDeploymentUpgrade

startDeployment

stopDeployment

testConnectionAssignment

updateConnection

updateDatabaseRegistration

updateDeployment

updateDeploymentBackup

upgradeDeployment

upgradeDeploymentUpgrade

getWaiters