@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.
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.
|
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.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
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.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateAddAnalyticsClusterResponse addAnalyticsCluster(AddAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Adds an Analytics Cluster to the DB System.
request
- The request object containing the details to sendBmcException
- 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 AddAnalyticsCluster API.
AddHeatWaveClusterResponse addHeatWaveCluster(AddHeatWaveClusterRequest request)
Adds a HeatWave cluster to the DB System.
request
- The request object containing the details to sendBmcException
- 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.
CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
Creates and launches a DB System.
request
- The request object containing the details to sendBmcException
- 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.
DeleteAnalyticsClusterResponse deleteAnalyticsCluster(DeleteAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Deletes the Analytics Cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
request
- The request object containing the details to sendBmcException
- 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 DeleteAnalyticsCluster API.
DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
request
- The request object containing the details to sendBmcException
- 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.
DeleteHeatWaveClusterResponse deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request)
Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
request
- The request object containing the details to sendBmcException
- 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.
GenerateAnalyticsClusterMemoryEstimateResponse generateAnalyticsClusterMemoryEstimate(GenerateAnalyticsClusterMemoryEstimateRequest request)
DEPRECATED – please use HeatWave API instead. Sends a request to estimate the memory footprints of user tables when loaded to Analytics Cluster memory.
request
- The request object containing the details to sendBmcException
- 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 GenerateAnalyticsClusterMemoryEstimate API.
GenerateHeatWaveClusterMemoryEstimateResponse generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)
Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
request
- The request object containing the details to sendBmcException
- 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.
GetAnalyticsClusterResponse getAnalyticsCluster(GetAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Gets information about the Analytics Cluster.
request
- The request object containing the details to sendBmcException
- 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 GetAnalyticsCluster API.
GetAnalyticsClusterMemoryEstimateResponse getAnalyticsClusterMemoryEstimate(GetAnalyticsClusterMemoryEstimateRequest request)
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.
request
- The request object containing the details to sendBmcException
- 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 GetAnalyticsClusterMemoryEstimate API.
GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
Get information about the specified DB System.
request
- The request object containing the details to sendBmcException
- 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.
GetHeatWaveClusterResponse getHeatWaveCluster(GetHeatWaveClusterRequest request)
Gets information about the HeatWave cluster.
request
- The request object containing the details to sendBmcException
- 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.
GetHeatWaveClusterMemoryEstimateResponse getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request)
Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
request
- The request object containing the details to sendBmcException
- 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.
ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
request
- The request object containing the details to sendBmcException
- 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.
RestartAnalyticsClusterResponse restartAnalyticsCluster(RestartAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Restarts the Analytics Cluster.
request
- The request object containing the details to sendBmcException
- 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 RestartAnalyticsCluster API.
RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)
Restarts the specified DB System.
request
- The request object containing the details to sendBmcException
- 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.
RestartHeatWaveClusterResponse restartHeatWaveCluster(RestartHeatWaveClusterRequest request)
Restarts the HeatWave cluster.
request
- The request object containing the details to sendBmcException
- 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.
StartAnalyticsClusterResponse startAnalyticsCluster(StartAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Starts the Analytics Cluster.
request
- The request object containing the details to sendBmcException
- 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 StartAnalyticsCluster API.
StartDbSystemResponse startDbSystem(StartDbSystemRequest request)
Start the specified DB System.
request
- The request object containing the details to sendBmcException
- 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.
StartHeatWaveClusterResponse startHeatWaveCluster(StartHeatWaveClusterRequest request)
Starts the HeatWave cluster.
request
- The request object containing the details to sendBmcException
- 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.
StopAnalyticsClusterResponse stopAnalyticsCluster(StopAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Stops the Analytics Cluster.
request
- The request object containing the details to sendBmcException
- 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 StopAnalyticsCluster API.
StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)
Stops the specified DB System.
A stopped DB System is not billed.
request
- The request object containing the details to sendBmcException
- 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.
StopHeatWaveClusterResponse stopHeatWaveCluster(StopHeatWaveClusterRequest request)
Stops the HeatWave cluster.
request
- The request object containing the details to sendBmcException
- 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.
UpdateAnalyticsClusterResponse updateAnalyticsCluster(UpdateAnalyticsClusterRequest request)
DEPRECATED – please use HeatWave API instead. Updates the Analytics Cluster.
request
- The request object containing the details to sendBmcException
- 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 UpdateAnalyticsCluster API.
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.
request
- The request object containing the details to sendBmcException
- 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.
UpdateHeatWaveClusterResponse updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)
Updates the HeatWave cluster.
request
- The request object containing the details to sendBmcException
- 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.
DbSystemWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2023. All rights reserved.