com.oracle.bmc.mysql

Interface ChannelsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ChannelsAsyncClient

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

The API for the MySQL Database Service

Method Summary

Modifier and Type	Method and Description
Future<CreateChannelResponse>	createChannel(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResponse> handler) Creates a Channel to establish replication from a source to a target.
Future<DeleteChannelResponse>	deleteChannel(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResponse> handler) Deletes the specified Channel.
Future<GetChannelResponse>	getChannel(GetChannelRequest request, AsyncHandler<GetChannelRequest,GetChannelResponse> handler) Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListChannelsResponse>	listChannels(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResponse> handler) Lists all the Channels that match the specified filters.
void	refreshClient() Rebuilds the client from scratch.
Future<ResetChannelResponse>	resetChannel(ResetChannelRequest request, AsyncHandler<ResetChannelRequest,ResetChannelResponse> handler) Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created.
Future<ResumeChannelResponse>	resumeChannel(ResumeChannelRequest request, AsyncHandler<ResumeChannelRequest,ResumeChannelResponse> handler) Resumes an enabled Channel that has become Inactive due to an error.
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<UpdateChannelResponse>	updateChannel(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResponse> handler) Updates the properties of the specified Channel.
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

createChannel

Future<CreateChannelResponse> createChannel(CreateChannelRequest request,
                                            AsyncHandler<CreateChannelRequest,CreateChannelResponse> handler)

Creates a Channel to establish replication from a source to a target.

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.

deleteChannel

Future<DeleteChannelResponse> deleteChannel(DeleteChannelRequest request,
                                            AsyncHandler<DeleteChannelRequest,DeleteChannelResponse> handler)

Deletes the specified Channel.

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.

getChannel

Future<GetChannelResponse> getChannel(GetChannelRequest request,
                                      AsyncHandler<GetChannelRequest,GetChannelResponse> handler)

Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets.

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.

listChannels

Future<ListChannelsResponse> listChannels(ListChannelsRequest request,
                                          AsyncHandler<ListChannelsRequest,ListChannelsResponse> handler)

Lists all the Channels 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.

resetChannel

Future<ResetChannelResponse> resetChannel(ResetChannelRequest request,
                                          AsyncHandler<ResetChannelRequest,ResetChannelResponse> handler)

Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created. This operation is only accepted in Inactive Channels.

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.

resumeChannel

Future<ResumeChannelResponse> resumeChannel(ResumeChannelRequest request,
                                            AsyncHandler<ResumeChannelRequest,ResumeChannelResponse> handler)

Resumes an enabled Channel that has become Inactive due to an error. The resume operation requires that the error that cause the Channel to become Inactive has already been fixed, otherwise the operation may fail.

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.

updateChannel

Future<UpdateChannelResponse> updateChannel(UpdateChannelRequest request,
                                            AsyncHandler<UpdateChannelRequest,UpdateChannelResponse> handler)

Updates the properties of the specified Channel. If the Channel is Active the Update operation will asynchronously apply the new configuration parameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the new configuration will be applied the next time the Channel becomes Active.

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.