com.oracle.bmc.mysql

Interface Channels

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ChannelsClient

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

The API for the MySQL Database Service 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
CreateChannelResponse	createChannel(CreateChannelRequest request) Creates a Channel to establish replication from a source to a target.
DeleteChannelResponse	deleteChannel(DeleteChannelRequest request) Deletes the specified Channel.
GetChannelResponse	getChannel(GetChannelRequest request) 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)
ChannelsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ChannelsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListChannelsResponse	listChannels(ListChannelsRequest request) Lists all the Channels that match the specified filters.
void	refreshClient() Rebuilds the client from scratch.
ResetChannelResponse	resetChannel(ResetChannelRequest request) Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created.
ResumeChannelResponse	resumeChannel(ResumeChannelRequest request) 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’).
UpdateChannelResponse	updateChannel(UpdateChannelRequest request) 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 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

createChannel

CreateChannelResponse createChannel(CreateChannelRequest request)

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

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 CreateChannel API.

deleteChannel

DeleteChannelResponse deleteChannel(DeleteChannelRequest request)

Deletes the specified Channel.

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 DeleteChannel API.

getChannel

GetChannelResponse getChannel(GetChannelRequest request)

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

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 GetChannel API.

listChannels

ListChannelsResponse listChannels(ListChannelsRequest request)

Lists all the Channels that match the specified filters.

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 ListChannels API.

resetChannel

ResetChannelResponse resetChannel(ResetChannelRequest request)

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

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 ResetChannel API.

resumeChannel

ResumeChannelResponse resumeChannel(ResumeChannelRequest request)

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

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 ResumeChannel API.

updateChannel

UpdateChannelResponse updateChannel(UpdateChannelRequest request)

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

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 UpdateChannel API.

getWaiters

ChannelsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

ChannelsPaginators 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.