DbSystemClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.mysql.DbSystemClient

All Implemented Interfaces:: DbSystem, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class DbSystemClient
extends Object
implements DbSystem

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DbSystemClient.Builder
Builder class for this client.

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

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for DbSystem.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(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.
	`DbSystemClient(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.
	`DbSystemClient(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`	`DbSystemClient(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.
	`DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(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
`AddAnalyticsClusterResponse`	`addAnalyticsCluster(AddAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`AddHeatWaveClusterResponse`	`addHeatWaveCluster(AddHeatWaveClusterRequest request)` Adds a HeatWave cluster to the DB System.
`static DbSystemClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`CreateDbSystemResponse`	`createDbSystem(CreateDbSystemRequest request)` Creates and launches a DB System.
`DeleteAnalyticsClusterResponse`	`deleteAnalyticsCluster(DeleteAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`DeleteDbSystemResponse`	`deleteDbSystem(DeleteDbSystemRequest request)` Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
`DeleteHeatWaveClusterResponse`	`deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request)` Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
`GenerateAnalyticsClusterMemoryEstimateResponse`	`generateAnalyticsClusterMemoryEstimate(GenerateAnalyticsClusterMemoryEstimateRequest request)` DEPRECATED – please use HeatWave API instead.
`GenerateHeatWaveClusterMemoryEstimateResponse`	`generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)` Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
`GetAnalyticsClusterResponse`	`getAnalyticsCluster(GetAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`GetAnalyticsClusterMemoryEstimateResponse`	`getAnalyticsClusterMemoryEstimate(GetAnalyticsClusterMemoryEstimateRequest request)` DEPRECATED – please use HeatWave API instead.
`GetDbSystemResponse`	`getDbSystem(GetDbSystemRequest request)` Get information about the specified DB System.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetHeatWaveClusterResponse`	`getHeatWaveCluster(GetHeatWaveClusterRequest request)` Gets information about the HeatWave cluster.
`GetHeatWaveClusterMemoryEstimateResponse`	`getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request)` Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
`DbSystemPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`DbSystemWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListDbSystemsResponse`	`listDbSystems(ListDbSystemsRequest request)` Get a list of DB Systems in the specified compartment.
`RestartAnalyticsClusterResponse`	`restartAnalyticsCluster(RestartAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`RestartDbSystemResponse`	`restartDbSystem(RestartDbSystemRequest request)` Restarts the specified DB System.
`RestartHeatWaveClusterResponse`	`restartHeatWaveCluster(RestartHeatWaveClusterRequest request)` Restarts the HeatWave cluster.
`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’).
`StartAnalyticsClusterResponse`	`startAnalyticsCluster(StartAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`StartDbSystemResponse`	`startDbSystem(StartDbSystemRequest request)` Start the specified DB System.
`StartHeatWaveClusterResponse`	`startHeatWaveCluster(StartHeatWaveClusterRequest request)` Starts the HeatWave cluster.
`StopAnalyticsClusterResponse`	`stopAnalyticsCluster(StopAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`StopDbSystemResponse`	`stopDbSystem(StopDbSystemRequest request)` Stops the specified DB System.
`StopHeatWaveClusterResponse`	`stopHeatWaveCluster(StopHeatWaveClusterRequest request)` Stops the HeatWave cluster.
`UpdateAnalyticsClusterResponse`	`updateAnalyticsCluster(UpdateAnalyticsClusterRequest request)` DEPRECATED – please use HeatWave API instead.
`UpdateDbSystemResponse`	`updateDbSystem(UpdateDbSystemRequest request)` Update the configuration of a DB System.
`UpdateHeatWaveClusterResponse`	`updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)` Updates the HeatWave cluster.

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 DbSystem.
- Constructor Detail
  - DbSystemClient
```
public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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)
  - DbSystemClient
```
public DbSystemClient(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)
  - DbSystemClient
```
public DbSystemClient(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
  - DbSystemClient
```
protected DbSystemClient(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 DbSystemClient.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 DbSystemClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: DbSystem
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface DbSystem
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: DbSystem
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface DbSystem
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - addAnalyticsCluster
```
public AddAnalyticsClusterResponse addAnalyticsCluster(AddAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Adds an Analytics Cluster to the DB System.
    
    Specified by:
    
    addAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addHeatWaveCluster
```
public AddHeatWaveClusterResponse addHeatWaveCluster(AddHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Adds a HeatWave cluster to the DB System.
    
    Specified by:
    
    addHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDbSystem
```
public CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Creates and launches a DB System.
    
    Specified by:
    
    createDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteAnalyticsCluster
```
public DeleteAnalyticsClusterResponse deleteAnalyticsCluster(DeleteAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Deletes the Analytics Cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    Specified by:
    
    deleteAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDbSystem
```
public DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    Specified by:
    
    deleteDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteHeatWaveCluster
```
public DeleteHeatWaveClusterResponse deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    Specified by:
    
    deleteHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - generateAnalyticsClusterMemoryEstimate
```
public GenerateAnalyticsClusterMemoryEstimateResponse generateAnalyticsClusterMemoryEstimate(GenerateAnalyticsClusterMemoryEstimateRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Sends a request to estimate the memory footprints of user tables when loaded to Analytics Cluster memory.
    
    Specified by:
    
    generateAnalyticsClusterMemoryEstimate in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - generateHeatWaveClusterMemoryEstimate
```
public GenerateHeatWaveClusterMemoryEstimateResponse generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)
```
    Description copied from interface: DbSystem
    
    Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
    
    Specified by:
    
    generateHeatWaveClusterMemoryEstimate in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getAnalyticsCluster
```
public GetAnalyticsClusterResponse getAnalyticsCluster(GetAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Gets information about the Analytics Cluster.
    
    Specified by:
    
    getAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getAnalyticsClusterMemoryEstimate
```
public GetAnalyticsClusterMemoryEstimateResponse getAnalyticsClusterMemoryEstimate(GetAnalyticsClusterMemoryEstimateRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Gets the most recent Analytics Cluster memory estimate that can be used to determine a suitable Analytics Cluster size.
    
    Specified by:
    
    getAnalyticsClusterMemoryEstimate in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDbSystem
```
public GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Get information about the specified DB System.
    
    Specified by:
    
    getDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getHeatWaveCluster
```
public GetHeatWaveClusterResponse getHeatWaveCluster(GetHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Gets information about the HeatWave cluster.
    
    Specified by:
    
    getHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getHeatWaveClusterMemoryEstimate
```
public GetHeatWaveClusterMemoryEstimateResponse getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request)
```
    Description copied from interface: DbSystem
    
    Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
    
    Specified by:
    
    getHeatWaveClusterMemoryEstimate in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDbSystems
```
public ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
```
    Description copied from interface: DbSystem
    
    Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
    
    Specified by:
    
    listDbSystems in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restartAnalyticsCluster
```
public RestartAnalyticsClusterResponse restartAnalyticsCluster(RestartAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Restarts the Analytics Cluster.
    
    Specified by:
    
    restartAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restartDbSystem
```
public RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Restarts the specified DB System.
    
    Specified by:
    
    restartDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restartHeatWaveCluster
```
public RestartHeatWaveClusterResponse restartHeatWaveCluster(RestartHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Restarts the HeatWave cluster.
    
    Specified by:
    
    restartHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startAnalyticsCluster
```
public StartAnalyticsClusterResponse startAnalyticsCluster(StartAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Starts the Analytics Cluster.
    
    Specified by:
    
    startAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startDbSystem
```
public StartDbSystemResponse startDbSystem(StartDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Start the specified DB System.
    
    Specified by:
    
    startDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startHeatWaveCluster
```
public StartHeatWaveClusterResponse startHeatWaveCluster(StartHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Starts the HeatWave cluster.
    
    Specified by:
    
    startHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopAnalyticsCluster
```
public StopAnalyticsClusterResponse stopAnalyticsCluster(StopAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Stops the Analytics Cluster.
    
    Specified by:
    
    stopAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopDbSystem
```
public StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Stops the specified DB System.
    
    A stopped DB System is not billed.
    
    Specified by:
    
    stopDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopHeatWaveCluster
```
public StopHeatWaveClusterResponse stopHeatWaveCluster(StopHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Stops the HeatWave cluster.
    
    Specified by:
    
    stopHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateAnalyticsCluster
```
public UpdateAnalyticsClusterResponse updateAnalyticsCluster(UpdateAnalyticsClusterRequest request)
```
    Description copied from interface: DbSystem
    
    DEPRECATED – please use HeatWave API instead. Updates the Analytics Cluster.
    
    Specified by:
    
    updateAnalyticsCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDbSystem
```
public UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Update the configuration of a DB System.
    
    Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.
    
    Specified by:
    
    updateDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateHeatWaveCluster
```
public UpdateHeatWaveClusterResponse updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)
```
    Description copied from interface: DbSystem
    
    Updates the HeatWave cluster.
    
    Specified by:
    
    updateHeatWaveCluster in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public DbSystemWaiters getWaiters()
```
    Description copied from interface: DbSystem
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface DbSystem
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public DbSystemPaginators getPaginators()
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Returns:
    
    The service paginators.

Class DbSystemClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

addAnalyticsCluster

addHeatWaveCluster

createDbSystem

deleteAnalyticsCluster

deleteDbSystem

deleteHeatWaveCluster

generateAnalyticsClusterMemoryEstimate

generateHeatWaveClusterMemoryEstimate

getAnalyticsCluster

getAnalyticsClusterMemoryEstimate

getDbSystem

getHeatWaveCluster

getHeatWaveClusterMemoryEstimate

listDbSystems

restartAnalyticsCluster

restartDbSystem

restartHeatWaveCluster

startAnalyticsCluster

startDbSystem

startHeatWaveCluster

stopAnalyticsCluster

stopDbSystem

stopHeatWaveCluster

updateAnalyticsCluster

updateDbSystem

updateHeatWaveCluster

getWaiters

getPaginators