GoldenGateClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.goldengate.GoldenGateClient

All Implemented Interfaces:: GoldenGate, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public class GoldenGateClient
extends Object
implements GoldenGate

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GoldenGateClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoldenGateClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for GoldenGate.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for GoldenGate.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GoldenGateClient.Builder`	`builder()` Create a builder for this client.
`CancelDeploymentBackupResponse`	`cancelDeploymentBackup(CancelDeploymentBackupRequest request)` Cancels a Deployment Backup creation process.
`ChangeDatabaseRegistrationCompartmentResponse`	`changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)` Moves the DatabaseRegistration into a different compartment within the same tenancy.
`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.
`void`	`close()`
`CreateDatabaseRegistrationResponse`	`createDatabaseRegistration(CreateDatabaseRegistrationRequest request)` Creates a new DatabaseRegistration.
`CreateDeploymentResponse`	`createDeployment(CreateDeploymentRequest request)` Creates a new Deployment.
`CreateDeploymentBackupResponse`	`createDeploymentBackup(CreateDeploymentBackupRequest request)` Creates a new DeploymentBackup.
`DeleteDatabaseRegistrationResponse`	`deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)` Deletes a DatabaseRegistration.
`DeleteDeploymentResponse`	`deleteDeployment(DeleteDeploymentRequest request)` Deletes the Deployment.
`DeleteDeploymentBackupResponse`	`deleteDeploymentBackup(DeleteDeploymentBackupRequest request)` Deletes a DeploymentBackup.
`GetDatabaseRegistrationResponse`	`getDatabaseRegistration(GetDatabaseRegistrationRequest request)` Retrieves a DatabaseRegistration.
`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.
`ListDatabaseRegistrationsResponse`	`listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)` Lists the DatabaseRegistrations in the compartment.
`ListDeploymentBackupsResponse`	`listDeploymentBackups(ListDeploymentBackupsRequest request)` Lists the Backups in a compartment.
`ListDeploymentsResponse`	`listDeployments(ListDeploymentsRequest request)` Lists the Deployments in a compartment.
`ListDeploymentUpgradesResponse`	`listDeploymentUpgrades(ListDeploymentUpgradesRequest request)` Lists the Deployment Upgrades in a compartment.
`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.
`RestoreDeploymentResponse`	`restoreDeployment(RestoreDeploymentRequest request)` Restores a Deployment from a Deployment Backup created from the same Deployment.
`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’).
`StartDeploymentResponse`	`startDeployment(StartDeploymentRequest request)` Starts a Deployment.
`StopDeploymentResponse`	`stopDeployment(StopDeploymentRequest request)` Stops a Deployment.
`UpdateDatabaseRegistrationResponse`	`updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)` Updates the DatabaseRegistration.
`UpdateDeploymentResponse`	`updateDeployment(UpdateDeploymentRequest request)` Modifies a Deployment.
`UpdateDeploymentBackupResponse`	`updateDeploymentBackup(UpdateDeploymentBackupRequest request)` Modifies a Deployment Backup.
`UpgradeDeploymentResponse`	`upgradeDeployment(UpgradeDeploymentRequest request)` Upgrade a Deployment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GoldenGate.
- Constructor Detail
  - GoldenGateClient
```
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - GoldenGateClient
```
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - GoldenGateClient
```
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - GoldenGateClient
```
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - GoldenGateClient
```
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - GoldenGateClient
```
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - GoldenGateClient
```
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - GoldenGateClient
```
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint,
                        ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - GoldenGateClient
```
protected GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           ExecutorService executorService,
                           RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the GoldenGateClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static GoldenGateClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: GoldenGate
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface GoldenGate
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: GoldenGate
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface GoldenGate
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: GoldenGate
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface GoldenGate
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GoldenGate
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface GoldenGate
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GoldenGate
    
    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.
    
    Specified by:
    
    setRegion in interface GoldenGate
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - cancelDeploymentBackup
```
public CancelDeploymentBackupResponse cancelDeploymentBackup(CancelDeploymentBackupRequest request)
```
    Description copied from interface: GoldenGate
    
    Cancels a Deployment Backup creation process.
    
    Specified by:
    
    cancelDeploymentBackup in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDatabaseRegistrationCompartment
```
public ChangeDatabaseRegistrationCompartmentResponse changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)
```
    Description copied from interface: GoldenGate
    
    Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDatabaseRegistrationCompartment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDeploymentBackupCompartment
```
public ChangeDeploymentBackupCompartmentResponse changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request)
```
    Description copied from interface: GoldenGate
    
    Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDeploymentBackupCompartment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDeploymentCompartment
```
public ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)
```
    Description copied from interface: GoldenGate
    
    Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
    
    Specified by:
    
    changeDeploymentCompartment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDatabaseRegistration
```
public CreateDatabaseRegistrationResponse createDatabaseRegistration(CreateDatabaseRegistrationRequest request)
```
    Description copied from interface: GoldenGate
    
    Creates a new DatabaseRegistration.
    
    Specified by:
    
    createDatabaseRegistration in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDeployment
```
public CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Creates a new Deployment.
    
    Specified by:
    
    createDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDeploymentBackup
```
public CreateDeploymentBackupResponse createDeploymentBackup(CreateDeploymentBackupRequest request)
```
    Description copied from interface: GoldenGate
    
    Creates a new DeploymentBackup.
    
    Specified by:
    
    createDeploymentBackup in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDatabaseRegistration
```
public DeleteDatabaseRegistrationResponse deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)
```
    Description copied from interface: GoldenGate
    
    Deletes a DatabaseRegistration.
    
    Specified by:
    
    deleteDatabaseRegistration in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDeployment
```
public DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Deletes the Deployment.
    
    Specified by:
    
    deleteDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDeploymentBackup
```
public DeleteDeploymentBackupResponse deleteDeploymentBackup(DeleteDeploymentBackupRequest request)
```
    Description copied from interface: GoldenGate
    
    Deletes a DeploymentBackup.
    
    Specified by:
    
    deleteDeploymentBackup in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDatabaseRegistration
```
public GetDatabaseRegistrationResponse getDatabaseRegistration(GetDatabaseRegistrationRequest request)
```
    Description copied from interface: GoldenGate
    
    Retrieves a DatabaseRegistration.
    
    Specified by:
    
    getDatabaseRegistration in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDeployment
```
public GetDeploymentResponse getDeployment(GetDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Retrieves a deployment.
    
    Specified by:
    
    getDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDeploymentBackup
```
public GetDeploymentBackupResponse getDeploymentBackup(GetDeploymentBackupRequest request)
```
    Description copied from interface: GoldenGate
    
    Retrieves a DeploymentBackup.
    
    Specified by:
    
    getDeploymentBackup in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDeploymentUpgrade
```
public GetDeploymentUpgradeResponse getDeploymentUpgrade(GetDeploymentUpgradeRequest request)
```
    Description copied from interface: GoldenGate
    
    Retrieves a deployment upgrade.
    
    Specified by:
    
    getDeploymentUpgrade in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: GoldenGate
    
    Retrieve the WorkRequest identified by the given OCID.
    
    Specified by:
    
    getWorkRequest in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDatabaseRegistrations
```
public ListDatabaseRegistrationsResponse listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists the DatabaseRegistrations in the compartment.
    
    Specified by:
    
    listDatabaseRegistrations in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDeploymentBackups
```
public ListDeploymentBackupsResponse listDeploymentBackups(ListDeploymentBackupsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists the Backups in a compartment.
    
    Specified by:
    
    listDeploymentBackups in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDeploymentUpgrades
```
public ListDeploymentUpgradesResponse listDeploymentUpgrades(ListDeploymentUpgradesRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists the Deployment Upgrades in a compartment.
    
    Specified by:
    
    listDeploymentUpgrades in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDeployments
```
public ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists the Deployments in a compartment.
    
    Specified by:
    
    listDeployments in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists work request errors.
    
    Specified by:
    
    listWorkRequestErrors in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists work request logs.
    
    Specified by:
    
    listWorkRequestLogs in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: GoldenGate
    
    Lists the work requests in the compartment.
    
    Specified by:
    
    listWorkRequests in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restoreDeployment
```
public RestoreDeploymentResponse restoreDeployment(RestoreDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Restores a Deployment from a Deployment Backup created from the same Deployment.
    
    Specified by:
    
    restoreDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startDeployment
```
public StartDeploymentResponse startDeployment(StartDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    startDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopDeployment
```
public StopDeploymentResponse stopDeployment(StopDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    stopDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDatabaseRegistration
```
public UpdateDatabaseRegistrationResponse updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)
```
    Description copied from interface: GoldenGate
    
    Updates the DatabaseRegistration.
    
    Specified by:
    
    updateDatabaseRegistration in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDeployment
```
public UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Modifies a Deployment.
    
    Specified by:
    
    updateDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDeploymentBackup
```
public UpdateDeploymentBackupResponse updateDeploymentBackup(UpdateDeploymentBackupRequest request)
```
    Description copied from interface: GoldenGate
    
    Modifies a Deployment Backup.
    
    Specified by:
    
    updateDeploymentBackup in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - upgradeDeployment
```
public UpgradeDeploymentResponse upgradeDeployment(UpgradeDeploymentRequest request)
```
    Description copied from interface: GoldenGate
    
    Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    upgradeDeployment in interface GoldenGate
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public GoldenGateWaiters getWaiters()
```
    Description copied from interface: GoldenGate
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface GoldenGate
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public GoldenGatePaginators getPaginators()
```
    Description copied from interface: GoldenGate
    
    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.
    
    Specified by:
    
    getPaginators in interface GoldenGate
    
    Returns:
    
    The service paginators.

Class GoldenGateClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

GoldenGateClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

cancelDeploymentBackup

changeDatabaseRegistrationCompartment

changeDeploymentBackupCompartment

changeDeploymentCompartment

createDatabaseRegistration

createDeployment

createDeploymentBackup

deleteDatabaseRegistration

deleteDeployment

deleteDeploymentBackup

getDatabaseRegistration

getDeployment

getDeploymentBackup

getDeploymentUpgrade

getWorkRequest

listDatabaseRegistrations

listDeploymentBackups

listDeploymentUpgrades

listDeployments

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

restoreDeployment

startDeployment

stopDeployment

updateDatabaseRegistration

updateDeployment

updateDeploymentBackup

upgradeDeployment

getWaiters

getPaginators