com.oracle.bmc.mysql

Interface MysqlaasAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MysqlaasAsyncClient

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

The API for the MySQL Database Service

Method Summary

Modifier and Type	Method and Description
Future<CreateConfigurationResponse>	createConfiguration(CreateConfigurationRequest request, AsyncHandler<CreateConfigurationRequest,CreateConfigurationResponse> handler) Creates a new Configuration.
Future<DeleteConfigurationResponse>	deleteConfiguration(DeleteConfigurationRequest request, AsyncHandler<DeleteConfigurationRequest,DeleteConfigurationResponse> handler) Deletes a Configuration.
Future<GetConfigurationResponse>	getConfiguration(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler) Get the full details of the specified Configuration, including the list of MySQL Variables and their values.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListConfigurationsResponse>	listConfigurations(ListConfigurationsRequest request, AsyncHandler<ListConfigurationsRequest,ListConfigurationsResponse> handler) Lists the Configurations available when creating a DB System.
Future<ListShapesResponse>	listShapes(ListShapesRequest request, AsyncHandler<ListShapesRequest,ListShapesResponse> handler) Gets a list of the shapes you can use to create a new MySQL DB System.
Future<ListVersionsResponse>	listVersions(ListVersionsRequest request, AsyncHandler<ListVersionsRequest,ListVersionsResponse> handler) Get a list of supported and available MySQL database major versions.
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’).
Future<UpdateConfigurationResponse>	updateConfiguration(UpdateConfigurationRequest request, AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler) Updates the Configuration details.
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

createConfiguration

Future<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest request,
                                                        AsyncHandler<CreateConfigurationRequest,CreateConfigurationResponse> handler)

Creates a new Configuration.

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.

deleteConfiguration

Future<DeleteConfigurationResponse> deleteConfiguration(DeleteConfigurationRequest request,
                                                        AsyncHandler<DeleteConfigurationRequest,DeleteConfigurationResponse> handler)

Deletes a Configuration. The Configuration must not be in use by any DB Systems.

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.

getConfiguration

Future<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request,
                                                  AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)

Get the full details of the specified Configuration, including the list of MySQL Variables and their values.

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.

listConfigurations

Future<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest request,
                                                      AsyncHandler<ListConfigurationsRequest,ListConfigurationsResponse> handler)

Lists the Configurations available when creating a DB System.

This may include DEFAULT configurations per Shape and CUSTOM configurations.

The default sort order is a multi-part sort by: - shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending

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.

listShapes

Future<ListShapesResponse> listShapes(ListShapesRequest request,
                                      AsyncHandler<ListShapesRequest,ListShapesResponse> handler)

Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

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.

listVersions

Future<ListVersionsResponse> listVersions(ListVersionsRequest request,
                                          AsyncHandler<ListVersionsRequest,ListVersionsResponse> handler)

Get a list of supported and available MySQL database major versions.

The list is sorted by version family.

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.

updateConfiguration

Future<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request,
                                                        AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler)

Updates the Configuration details.

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.