com.oracle.bmc.mysql

Interface ReplicasAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ReplicasAsyncClient

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

The API for the MySQL Database Service

Method Summary

Modifier and Type	Method and Description
Future<CreateReplicaResponse>	createReplica(CreateReplicaRequest request, AsyncHandler<CreateReplicaRequest,CreateReplicaResponse> handler) Creates a DB System read replica.
Future<DeleteReplicaResponse>	deleteReplica(DeleteReplicaRequest request, AsyncHandler<DeleteReplicaRequest,DeleteReplicaResponse> handler) Deletes the specified read replica.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetReplicaResponse>	getReplica(GetReplicaRequest request, AsyncHandler<GetReplicaRequest,GetReplicaResponse> handler) Gets the full details of the specified read replica.
Future<ListReplicasResponse>	listReplicas(ListReplicasRequest request, AsyncHandler<ListReplicasRequest,ListReplicasResponse> handler) Lists all the read replicas that match the specified filters.
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<UpdateReplicaResponse>	updateReplica(UpdateReplicaRequest request, AsyncHandler<UpdateReplicaRequest,UpdateReplicaResponse> handler) Updates the properties of the specified read replica.
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

createReplica

Future<CreateReplicaResponse> createReplica(CreateReplicaRequest request,
                                            AsyncHandler<CreateReplicaRequest,CreateReplicaResponse> handler)

Creates a DB System read replica.

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.

deleteReplica

Future<DeleteReplicaResponse> deleteReplica(DeleteReplicaRequest request,
                                            AsyncHandler<DeleteReplicaRequest,DeleteReplicaResponse> handler)

Deletes the specified read replica.

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.

getReplica

Future<GetReplicaResponse> getReplica(GetReplicaRequest request,
                                      AsyncHandler<GetReplicaRequest,GetReplicaResponse> handler)

Gets the full details of the specified read replica.

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.

listReplicas

Future<ListReplicasResponse> listReplicas(ListReplicasRequest request,
                                          AsyncHandler<ListReplicasRequest,ListReplicasResponse> handler)

Lists all the read replicas that match the specified filters.

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.

updateReplica

Future<UpdateReplicaResponse> updateReplica(UpdateReplicaRequest request,
                                            AsyncHandler<UpdateReplicaRequest,UpdateReplicaResponse> handler)

Updates the properties of the specified read replica.

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.