com.oracle.bmc.databasemanagement

Interface ManagedMySqlDatabases

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ManagedMySqlDatabasesClient

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

Use the Database Management API to monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems. For more information, see Database Management.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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.
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	refreshClient() Rebuilds the client from scratch.
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’).
SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse	summarizeManagedMySqlDatabaseAvailabilityMetrics(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request) Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.
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 service.

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

getHeatWaveFleetMetric

GetHeatWaveFleetMetricResponse getHeatWaveFleetMetric(GetHeatWaveFleetMetricRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetHeatWaveFleetMetric API.

getManagedMySqlDatabase

GetManagedMySqlDatabaseResponse getManagedMySqlDatabase(GetManagedMySqlDatabaseRequest request)

Retrieves the general information for a specific MySQL Database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetManagedMySqlDatabase API.

getMySqlFleetMetric

GetMySqlFleetMetricResponse getMySqlFleetMetric(GetMySqlFleetMetricRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetMySqlFleetMetric API.

listManagedMySqlDatabaseConfigurationData

ListManagedMySqlDatabaseConfigurationDataResponse listManagedMySqlDatabaseConfigurationData(ListManagedMySqlDatabaseConfigurationDataRequest request)

Retrieves configuration data for a specific MySQL database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedMySqlDatabaseConfigurationData API.

listManagedMySqlDatabaseSqlData

ListManagedMySqlDatabaseSqlDataResponse listManagedMySqlDatabaseSqlData(ListManagedMySqlDatabaseSqlDataRequest request)

Retrieves the SQL performance data for a specific MySQL database.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedMySqlDatabaseSqlData API.

listManagedMySqlDatabases

ListManagedMySqlDatabasesResponse listManagedMySqlDatabases(ListManagedMySqlDatabasesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedMySqlDatabases API.

summarizeManagedMySqlDatabaseAvailabilityMetrics

SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse summarizeManagedMySqlDatabaseAvailabilityMetrics(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SummarizeManagedMySqlDatabaseAvailabilityMetrics API.

getPaginators

ManagedMySqlDatabasesPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.