DbSystem (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DbSystemClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public interface DbSystem
extends AutoCloseable
```
The API for the MySQL Database Service 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
`AddHeatWaveClusterResponse`	`addHeatWaveCluster(AddHeatWaveClusterRequest request)` Adds a HeatWave cluster to the DB System.
`CreateDbSystemResponse`	`createDbSystem(CreateDbSystemRequest request)` Creates and launches a DB System.
`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.
`GenerateHeatWaveClusterMemoryEstimateResponse`	`generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)` Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
`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.
`void`	`refreshClient()` Rebuilds the client from scratch.
`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’).
`StartDbSystemResponse`	`startDbSystem(StartDbSystemRequest request)` Start the specified DB System.
`StartHeatWaveClusterResponse`	`startHeatWaveCluster(StartHeatWaveClusterRequest request)` Starts the HeatWave cluster.
`StopDbSystemResponse`	`stopDbSystem(StopDbSystemRequest request)` Stops the specified DB System.
`StopHeatWaveClusterResponse`	`stopHeatWaveCluster(StopHeatWaveClusterRequest request)` Stops the HeatWave cluster.
`UpdateDbSystemResponse`	`updateDbSystem(UpdateDbSystemRequest request)` Update the configuration of a DB System.
`UpdateHeatWaveClusterResponse`	`updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)` Updates the HeatWave cluster.
`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
  - addHeatWaveCluster
```
AddHeatWaveClusterResponse addHeatWaveCluster(AddHeatWaveClusterRequest request)
```
    Adds a HeatWave cluster to the DB System.
    
    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 AddHeatWaveCluster API.
  - createDbSystem
```
CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
```
    Creates and launches a DB System.
    
    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 CreateDbSystem API.
  - deleteDbSystem
```
DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
```
    Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    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 DeleteDbSystem API.
  - deleteHeatWaveCluster
```
DeleteHeatWaveClusterResponse deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request)
```
    Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    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 DeleteHeatWaveCluster API.
  - generateHeatWaveClusterMemoryEstimate
```
GenerateHeatWaveClusterMemoryEstimateResponse generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)
```
    Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
    
    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 GenerateHeatWaveClusterMemoryEstimate API.
  - getDbSystem
```
GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
```
    Get information about the specified DB System.
    
    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 GetDbSystem API.
  - getHeatWaveCluster
```
GetHeatWaveClusterResponse getHeatWaveCluster(GetHeatWaveClusterRequest request)
```
    Gets information about the HeatWave cluster.
    
    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 GetHeatWaveCluster API.
  - getHeatWaveClusterMemoryEstimate
```
GetHeatWaveClusterMemoryEstimateResponse getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request)
```
    Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
    
    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 GetHeatWaveClusterMemoryEstimate API.
  - listDbSystems
```
ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
```
    Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
    
    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 ListDbSystems API.
  - restartDbSystem
```
RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)
```
    Restarts the specified DB System.
    
    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 RestartDbSystem API.
  - restartHeatWaveCluster
```
RestartHeatWaveClusterResponse restartHeatWaveCluster(RestartHeatWaveClusterRequest request)
```
    Restarts the HeatWave cluster.
    
    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 RestartHeatWaveCluster API.
  - startDbSystem
```
StartDbSystemResponse startDbSystem(StartDbSystemRequest request)
```
    Start the specified DB System.
    
    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 StartDbSystem API.
  - startHeatWaveCluster
```
StartHeatWaveClusterResponse startHeatWaveCluster(StartHeatWaveClusterRequest request)
```
    Starts the HeatWave cluster.
    
    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 StartHeatWaveCluster API.
  - stopDbSystem
```
StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)
```
    Stops the specified DB System.
    
    A stopped DB System is not billed.
    
    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 StopDbSystem API.
  - stopHeatWaveCluster
```
StopHeatWaveClusterResponse stopHeatWaveCluster(StopHeatWaveClusterRequest request)
```
    Stops the HeatWave cluster.
    
    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 StopHeatWaveCluster API.
  - updateDbSystem
```
UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
```
    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.
    
    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 UpdateDbSystem API.
  - updateHeatWaveCluster
```
UpdateHeatWaveClusterResponse updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)
```
    Updates the HeatWave cluster.
    
    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 UpdateHeatWaveCluster API.
  - getWaiters
```
DbSystemWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
DbSystemPaginators 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 DbSystem

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

addHeatWaveCluster

createDbSystem

deleteDbSystem

deleteHeatWaveCluster

generateHeatWaveClusterMemoryEstimate

getDbSystem

getHeatWaveCluster

getHeatWaveClusterMemoryEstimate

listDbSystems

restartDbSystem

restartHeatWaveCluster

startDbSystem

startHeatWaveCluster

stopDbSystem

stopHeatWaveCluster

updateDbSystem

updateHeatWaveCluster

getWaiters

getPaginators