com.oracle.bmc.mysql

Interface DbSystemAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DbSystemAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public interface DbSystemAsync
extends AutoCloseable

The API for the MySQL Database Service

Method Summary

Modifier and Type	Method and Description
Future<AddHeatWaveClusterResponse>	addHeatWaveCluster(AddHeatWaveClusterRequest request, AsyncHandler<AddHeatWaveClusterRequest,AddHeatWaveClusterResponse> handler) Adds a HeatWave cluster to the DB System.
Future<CreateDbSystemResponse>	createDbSystem(CreateDbSystemRequest request, AsyncHandler<CreateDbSystemRequest,CreateDbSystemResponse> handler) Creates and launches a DB System.
Future<DeleteDbSystemResponse>	deleteDbSystem(DeleteDbSystemRequest request, AsyncHandler<DeleteDbSystemRequest,DeleteDbSystemResponse> handler) Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
Future<DeleteHeatWaveClusterResponse>	deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request, AsyncHandler<DeleteHeatWaveClusterRequest,DeleteHeatWaveClusterResponse> handler) Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
Future<GenerateHeatWaveClusterMemoryEstimateResponse>	generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request, AsyncHandler<GenerateHeatWaveClusterMemoryEstimateRequest,GenerateHeatWaveClusterMemoryEstimateResponse> handler) Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
Future<GetDbSystemResponse>	getDbSystem(GetDbSystemRequest request, AsyncHandler<GetDbSystemRequest,GetDbSystemResponse> handler) Get information about the specified DB System.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetHeatWaveClusterResponse>	getHeatWaveCluster(GetHeatWaveClusterRequest request, AsyncHandler<GetHeatWaveClusterRequest,GetHeatWaveClusterResponse> handler) Gets information about the HeatWave cluster.
Future<GetHeatWaveClusterMemoryEstimateResponse>	getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request, AsyncHandler<GetHeatWaveClusterMemoryEstimateRequest,GetHeatWaveClusterMemoryEstimateResponse> handler) Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
Future<ListDbSystemsResponse>	listDbSystems(ListDbSystemsRequest request, AsyncHandler<ListDbSystemsRequest,ListDbSystemsResponse> handler) Get a list of DB Systems in the specified compartment.
void	refreshClient() Rebuilds the client from scratch.
Future<RestartDbSystemResponse>	restartDbSystem(RestartDbSystemRequest request, AsyncHandler<RestartDbSystemRequest,RestartDbSystemResponse> handler) Restarts the specified DB System.
Future<RestartHeatWaveClusterResponse>	restartHeatWaveCluster(RestartHeatWaveClusterRequest request, AsyncHandler<RestartHeatWaveClusterRequest,RestartHeatWaveClusterResponse> handler) 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’).
Future<StartDbSystemResponse>	startDbSystem(StartDbSystemRequest request, AsyncHandler<StartDbSystemRequest,StartDbSystemResponse> handler) Start the specified DB System.
Future<StartHeatWaveClusterResponse>	startHeatWaveCluster(StartHeatWaveClusterRequest request, AsyncHandler<StartHeatWaveClusterRequest,StartHeatWaveClusterResponse> handler) Starts the HeatWave cluster.
Future<StopDbSystemResponse>	stopDbSystem(StopDbSystemRequest request, AsyncHandler<StopDbSystemRequest,StopDbSystemResponse> handler) Stops the specified DB System.
Future<StopHeatWaveClusterResponse>	stopHeatWaveCluster(StopHeatWaveClusterRequest request, AsyncHandler<StopHeatWaveClusterRequest,StopHeatWaveClusterResponse> handler) Stops the HeatWave cluster.
Future<UpdateDbSystemResponse>	updateDbSystem(UpdateDbSystemRequest request, AsyncHandler<UpdateDbSystemRequest,UpdateDbSystemResponse> handler) Update the configuration of a DB System.
Future<UpdateHeatWaveClusterResponse>	updateHeatWaveCluster(UpdateHeatWaveClusterRequest request, AsyncHandler<UpdateHeatWaveClusterRequest,UpdateHeatWaveClusterResponse> handler) 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 serice.

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

Future<AddHeatWaveClusterResponse> addHeatWaveCluster(AddHeatWaveClusterRequest request,
                                                      AsyncHandler<AddHeatWaveClusterRequest,AddHeatWaveClusterResponse> handler)

Adds a HeatWave cluster to the DB System.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createDbSystem

Future<CreateDbSystemResponse> createDbSystem(CreateDbSystemRequest request,
                                              AsyncHandler<CreateDbSystemRequest,CreateDbSystemResponse> handler)

Creates and launches a DB System.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteDbSystem

Future<DeleteDbSystemResponse> deleteDbSystem(DeleteDbSystemRequest request,
                                              AsyncHandler<DeleteDbSystemRequest,DeleteDbSystemResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteHeatWaveCluster

Future<DeleteHeatWaveClusterResponse> deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request,
                                                            AsyncHandler<DeleteHeatWaveClusterRequest,DeleteHeatWaveClusterResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

generateHeatWaveClusterMemoryEstimate

Future<GenerateHeatWaveClusterMemoryEstimateResponse> generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request,
                                                                                            AsyncHandler<GenerateHeatWaveClusterMemoryEstimateRequest,GenerateHeatWaveClusterMemoryEstimateResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDbSystem

Future<GetDbSystemResponse> getDbSystem(GetDbSystemRequest request,
                                        AsyncHandler<GetDbSystemRequest,GetDbSystemResponse> handler)

Get information about the specified DB System.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getHeatWaveCluster

Future<GetHeatWaveClusterResponse> getHeatWaveCluster(GetHeatWaveClusterRequest request,
                                                      AsyncHandler<GetHeatWaveClusterRequest,GetHeatWaveClusterResponse> handler)

Gets information about the HeatWave cluster.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getHeatWaveClusterMemoryEstimate

Future<GetHeatWaveClusterMemoryEstimateResponse> getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request,
                                                                                  AsyncHandler<GetHeatWaveClusterMemoryEstimateRequest,GetHeatWaveClusterMemoryEstimateResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDbSystems

Future<ListDbSystemsResponse> listDbSystems(ListDbSystemsRequest request,
                                            AsyncHandler<ListDbSystemsRequest,ListDbSystemsResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

restartDbSystem

Future<RestartDbSystemResponse> restartDbSystem(RestartDbSystemRequest request,
                                                AsyncHandler<RestartDbSystemRequest,RestartDbSystemResponse> handler)

Restarts the specified DB System.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

restartHeatWaveCluster

Future<RestartHeatWaveClusterResponse> restartHeatWaveCluster(RestartHeatWaveClusterRequest request,
                                                              AsyncHandler<RestartHeatWaveClusterRequest,RestartHeatWaveClusterResponse> handler)

Restarts the HeatWave cluster.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startDbSystem

Future<StartDbSystemResponse> startDbSystem(StartDbSystemRequest request,
                                            AsyncHandler<StartDbSystemRequest,StartDbSystemResponse> handler)

Start the specified DB System.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startHeatWaveCluster

Future<StartHeatWaveClusterResponse> startHeatWaveCluster(StartHeatWaveClusterRequest request,
                                                          AsyncHandler<StartHeatWaveClusterRequest,StartHeatWaveClusterResponse> handler)

Starts the HeatWave cluster.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopDbSystem

Future<StopDbSystemResponse> stopDbSystem(StopDbSystemRequest request,
                                          AsyncHandler<StopDbSystemRequest,StopDbSystemResponse> handler)

Stops the specified DB System.

A stopped DB System is not billed.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopHeatWaveCluster

Future<StopHeatWaveClusterResponse> stopHeatWaveCluster(StopHeatWaveClusterRequest request,
                                                        AsyncHandler<StopHeatWaveClusterRequest,StopHeatWaveClusterResponse> handler)

Stops the HeatWave cluster.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateDbSystem

Future<UpdateDbSystemResponse> updateDbSystem(UpdateDbSystemRequest request,
                                              AsyncHandler<UpdateDbSystemRequest,UpdateDbSystemResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateHeatWaveCluster

Future<UpdateHeatWaveClusterResponse> updateHeatWaveCluster(UpdateHeatWaveClusterRequest request,
                                                            AsyncHandler<UpdateHeatWaveClusterRequest,UpdateHeatWaveClusterResponse> handler)

Updates the HeatWave cluster.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.