Package com.oracle.bmc.mysql

Class DbSystemClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.mysql.DbSystemClient

All Implemented Interfaces:

DbSystem, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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	Description
DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
AddHeatWaveClusterResponse	addHeatWaveCluster(AddHeatWaveClusterRequest request)	Adds a HeatWave cluster to the DB System.
static DbSystemClient.Builder	builder()	Create a builder for this client.
void	close()
CreateDbSystemResponse	createDbSystem(CreateDbSystemRequest request)	Creates and launches a DB System.
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.
String	getClientCommonLibraryVersion()
GetDbSystemResponse	getDbSystem(GetDbSystemRequest request)	Get information about the specified DB System.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	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.
RestartDbSystemResponse	restartDbSystem(RestartDbSystemRequest request)	Restarts the specified DB System.
RestartHeatWaveClusterResponse	restartHeatWaveCluster(RestartHeatWaveClusterRequest request)	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’).
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.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateDbSystemResponse	updateDbSystem(UpdateDbSystemRequest request)	Update the configuration of a DB System.
UpdateHeatWaveClusterResponse	updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)	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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

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

DbSystemClient

@Deprecated
public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DbSystemClient

@Deprecated
public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DbSystemClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DbSystemClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DbSystemClient

@Deprecated
public DbSystemClient(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 DbSystemClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DbSystemClient

@Deprecated
public DbSystemClient(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 DbSystemClient.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)

DbSystemClient

@Deprecated
public DbSystemClient(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 DbSystemClient.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

DbSystemClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DbSystemClient.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

executorService - DbSystemClient.Builder.executorService

Method Detail

builder

public static DbSystemClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DbSystem

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface DbSystem

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DbSystem

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface DbSystem

Parameters:

regionId - The public region ID.

addHeatWaveCluster

public AddHeatWaveClusterResponse addHeatWaveCluster(AddHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Adds a HeatWave cluster to the DB System.

Specified by:

addHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDbSystem

public CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)

Description copied from interface: DbSystem

Creates and launches a DB System.

Specified by:

createDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDbSystem

public DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)

Description copied from interface: DbSystem

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

Specified by:

deleteDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteHeatWaveCluster

public DeleteHeatWaveClusterResponse deleteHeatWaveCluster(DeleteHeatWaveClusterRequest request)

Description copied from interface: DbSystem

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

Specified by:

deleteHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateHeatWaveClusterMemoryEstimate

public GenerateHeatWaveClusterMemoryEstimateResponse generateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request)

Description copied from interface: DbSystem

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

Specified by:

generateHeatWaveClusterMemoryEstimate in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDbSystem

public GetDbSystemResponse getDbSystem(GetDbSystemRequest request)

Description copied from interface: DbSystem

Get information about the specified DB System.

Specified by:

getDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getHeatWaveCluster

public GetHeatWaveClusterResponse getHeatWaveCluster(GetHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Gets information about the HeatWave cluster.

Specified by:

getHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getHeatWaveClusterMemoryEstimate

public GetHeatWaveClusterMemoryEstimateResponse getHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request)

Description copied from interface: DbSystem

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

Specified by:

getHeatWaveClusterMemoryEstimate in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDbSystems

public ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)

Description copied from interface: DbSystem

Get a list of DB Systems in the specified compartment.

The default sort order is by timeUpdated, descending.

Specified by:

listDbSystems in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

restartDbSystem

public RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)

Description copied from interface: DbSystem

Restarts the specified DB System.

Specified by:

restartDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

restartHeatWaveCluster

public RestartHeatWaveClusterResponse restartHeatWaveCluster(RestartHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Restarts the HeatWave cluster.

Specified by:

restartHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDbSystem

public StartDbSystemResponse startDbSystem(StartDbSystemRequest request)

Description copied from interface: DbSystem

Start the specified DB System.

Specified by:

startDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startHeatWaveCluster

public StartHeatWaveClusterResponse startHeatWaveCluster(StartHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Starts the HeatWave cluster.

Specified by:

startHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDbSystem

public StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)

Description copied from interface: DbSystem

Stops the specified DB System.

A stopped DB System is not billed.

Specified by:

stopDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopHeatWaveCluster

public StopHeatWaveClusterResponse stopHeatWaveCluster(StopHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Stops the HeatWave cluster.

Specified by:

stopHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDbSystem

public UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)

Description copied from interface: DbSystem

Update the configuration of a DB System.

Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.

Specified by:

updateDbSystem in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateHeatWaveCluster

public UpdateHeatWaveClusterResponse updateHeatWaveCluster(UpdateHeatWaveClusterRequest request)

Description copied from interface: DbSystem

Updates the HeatWave cluster.

Specified by:

updateHeatWaveCluster in interface DbSystem

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DbSystemWaiters getWaiters()

Description copied from interface: DbSystem

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DbSystem

Returns:

The service waiters.

getPaginators

public DbSystemPaginators getPaginators()

Description copied from interface: DbSystem

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DbSystem

Returns:

The service paginators.

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()