com.oracle.bmc.mysql

Class DbSystemAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.mysql.DbSystemAsyncClient

All Implemented Interfaces:

DbSystemAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class DbSystemAsyncClient
extends BaseAsyncClient
implements DbSystemAsync

Async client implementation for DbSystem service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbSystemAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for DbSystem.

Constructor Summary

Constructors

Constructor and Description
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

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.
static DbSystemAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
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.
String	getClientCommonLibraryVersion()
Future<GetDbSystemResponse>	getDbSystem(GetDbSystemRequest request, AsyncHandler<GetDbSystemRequest,GetDbSystemResponse> handler) Get information about the specified DB System.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListDbSystemsResponse>	listDbSystems(ListDbSystemsRequest request, AsyncHandler<ListDbSystemsRequest,ListDbSystemsResponse> handler) Get a list of DB Systems in the specified compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
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)
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.mysql.DbSystemAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DbSystem.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DbSystemAsyncClient

@Deprecated
public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static DbSystemAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DbSystemAsync

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 DbSystemAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DbSystemAsync

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 DbSystemAsync

Parameters:

regionId - The public region ID.

addHeatWaveCluster

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

Description copied from interface: DbSystemAsync

Adds a HeatWave cluster to the DB System.

Specified by:

addHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Creates and launches a DB System.

Specified by:

createDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

Specified by:

deleteDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

Specified by:

deleteHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.

Specified by:

generateHeatWaveClusterMemoryEstimate in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Get information about the specified DB System.

Specified by:

getDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Gets information about the HeatWave cluster.

Specified by:

getHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.

Specified by:

getHeatWaveClusterMemoryEstimate in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.

Specified by:

listDbSystems in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Restarts the specified DB System.

Specified by:

restartDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Restarts the HeatWave cluster.

Specified by:

restartHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Start the specified DB System.

Specified by:

startDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Starts the HeatWave cluster.

Specified by:

startHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Stops the specified DB System.

A stopped DB System is not billed.

Specified by:

stopDbSystem in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Stops the HeatWave cluster.

Specified by:

stopHeatWaveCluster in interface DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

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 DbSystemAsync

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

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

Description copied from interface: DbSystemAsync

Updates the HeatWave cluster.

Specified by:

updateHeatWaveCluster in interface DbSystemAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)