com.oracle.bmc.databasemanagement

Class ManagedMySqlDatabasesClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.databasemanagement.ManagedMySqlDatabasesClient

All Implemented Interfaces:

ManagedMySqlDatabases, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public class ManagedMySqlDatabasesClient
extends BaseSyncClient
implements ManagedMySqlDatabases

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManagedMySqlDatabasesClient.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 ManagedMySqlDatabases.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ManagedMySqlDatabasesClient.Builder	builder() Create a builder for this client.
void	close()
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetHeatWaveFleetMetricResponse	getHeatWaveFleetMetric(GetHeatWaveFleetMetricRequest request) Gets the health metrics for a fleet of HeatWave clusters in a compartment.
GetManagedMySqlDatabaseResponse	getManagedMySqlDatabase(GetManagedMySqlDatabaseRequest request) Retrieves the general information for a specific MySQL Database.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetMySqlFleetMetricResponse	getMySqlFleetMetric(GetMySqlFleetMetricRequest request) Gets the health metrics for a fleet of MySQL Databases in a compartment.
ManagedMySqlDatabasesPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListManagedMySqlDatabaseConfigurationDataResponse	listManagedMySqlDatabaseConfigurationData(ListManagedMySqlDatabaseConfigurationDataRequest request) Retrieves configuration data for a specific MySQL database.
ListManagedMySqlDatabasesResponse	listManagedMySqlDatabases(ListManagedMySqlDatabasesRequest request) Gets the list of Managed MySQL Databases in a specific compartment.
ListManagedMySqlDatabaseSqlDataResponse	listManagedMySqlDatabaseSqlData(ListManagedMySqlDatabaseSqlDataRequest request) Retrieves the SQL performance data for a specific MySQL database.
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.
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’).
SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse	summarizeManagedMySqlDatabaseAvailabilityMetrics(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request) Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 com.oracle.bmc.databasemanagement.ManagedMySqlDatabases

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagedMySqlDatabases.

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

ManagedMySqlDatabasesClient

@Deprecated
public ManagedMySqlDatabasesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagedMySqlDatabasesClient

@Deprecated
public ManagedMySqlDatabasesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagedMySqlDatabasesClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagedMySqlDatabasesClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagedMySqlDatabasesClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagedMySqlDatabasesClient

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

ManagedMySqlDatabasesClient

@Deprecated
public ManagedMySqlDatabasesClient(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 ManagedMySqlDatabasesClient.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 ManagedMySqlDatabasesClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagedMySqlDatabases

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 ManagedMySqlDatabases

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagedMySqlDatabases

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 ManagedMySqlDatabases

Parameters:

regionId - The public region ID.

getHeatWaveFleetMetric

public GetHeatWaveFleetMetricResponse getHeatWaveFleetMetric(GetHeatWaveFleetMetricRequest request)

Description copied from interface: ManagedMySqlDatabases

Gets the health metrics for a fleet of HeatWave clusters in a compartment.

Specified by:

getHeatWaveFleetMetric in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getManagedMySqlDatabase

public GetManagedMySqlDatabaseResponse getManagedMySqlDatabase(GetManagedMySqlDatabaseRequest request)

Description copied from interface: ManagedMySqlDatabases

Retrieves the general information for a specific MySQL Database.

Specified by:

getManagedMySqlDatabase in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMySqlFleetMetric

public GetMySqlFleetMetricResponse getMySqlFleetMetric(GetMySqlFleetMetricRequest request)

Description copied from interface: ManagedMySqlDatabases

Gets the health metrics for a fleet of MySQL Databases in a compartment.

Specified by:

getMySqlFleetMetric in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedMySqlDatabaseConfigurationData

public ListManagedMySqlDatabaseConfigurationDataResponse listManagedMySqlDatabaseConfigurationData(ListManagedMySqlDatabaseConfigurationDataRequest request)

Description copied from interface: ManagedMySqlDatabases

Retrieves configuration data for a specific MySQL database.

Specified by:

listManagedMySqlDatabaseConfigurationData in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedMySqlDatabaseSqlData

public ListManagedMySqlDatabaseSqlDataResponse listManagedMySqlDatabaseSqlData(ListManagedMySqlDatabaseSqlDataRequest request)

Description copied from interface: ManagedMySqlDatabases

Retrieves the SQL performance data for a specific MySQL database.

Specified by:

listManagedMySqlDatabaseSqlData in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedMySqlDatabases

public ListManagedMySqlDatabasesResponse listManagedMySqlDatabases(ListManagedMySqlDatabasesRequest request)

Description copied from interface: ManagedMySqlDatabases

Gets the list of Managed MySQL Databases in a specific compartment.

Specified by:

listManagedMySqlDatabases in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeManagedMySqlDatabaseAvailabilityMetrics

public SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse summarizeManagedMySqlDatabaseAvailabilityMetrics(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request)

Description copied from interface: ManagedMySqlDatabases

Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.

Specified by:

summarizeManagedMySqlDatabaseAvailabilityMetrics in interface ManagedMySqlDatabases

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public ManagedMySqlDatabasesPaginators getPaginators()

Description copied from interface: ManagedMySqlDatabases

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 ManagedMySqlDatabases

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