ChannelsAsyncClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.mysql.ChannelsAsyncClient

All Implemented Interfaces:

ChannelsAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class ChannelsAsyncClient
extends Object
implements ChannelsAsync
```
Async client implementation for Channels service.
There are two ways to use async client:
1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
  Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
  Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChannelsAsyncClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChannelsAsyncClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for Channels.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Channels.

Constructor Summary

Constructors
Constructor and Description
`ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
`ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
`ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ChannelsAsyncClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Channels.
- Constructor Detail
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - ChannelsAsyncClient
```
public ChannelsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static ChannelsAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: ChannelsAsync
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface ChannelsAsync
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: ChannelsAsync
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface ChannelsAsync
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: ChannelsAsync
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface ChannelsAsync
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    setRegion in interface ChannelsAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    setRegion in interface ChannelsAsync
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - createChannel
```
public Future<CreateChannelResponse> createChannel(CreateChannelRequest request,
                                                   AsyncHandler<CreateChannelRequest,CreateChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    Creates a Channel to establish replication from a source to a target.
    
    Specified by:
    
    createChannel in interface ChannelsAsync
    
    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
```
public Future<DeleteChannelResponse> deleteChannel(DeleteChannelRequest request,
                                                   AsyncHandler<DeleteChannelRequest,DeleteChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    Deletes the specified Channel.
    
    Specified by:
    
    deleteChannel in interface ChannelsAsync
    
    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
```
public Future<GetChannelResponse> getChannel(GetChannelRequest request,
                                             AsyncHandler<GetChannelRequest,GetChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    getChannel in interface ChannelsAsync
    
    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
```
public Future<ListChannelsResponse> listChannels(ListChannelsRequest request,
                                                 AsyncHandler<ListChannelsRequest,ListChannelsResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    Lists all the Channels that match the specified filters.
    
    Specified by:
    
    listChannels in interface ChannelsAsync
    
    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
```
public Future<ResetChannelResponse> resetChannel(ResetChannelRequest request,
                                                 AsyncHandler<ResetChannelRequest,ResetChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    resetChannel in interface ChannelsAsync
    
    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
```
public Future<ResumeChannelResponse> resumeChannel(ResumeChannelRequest request,
                                                   AsyncHandler<ResumeChannelRequest,ResumeChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    resumeChannel in interface ChannelsAsync
    
    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
```
public Future<UpdateChannelResponse> updateChannel(UpdateChannelRequest request,
                                                   AsyncHandler<UpdateChannelRequest,UpdateChannelResponse> handler)
```
    Description copied from interface: ChannelsAsync
    
    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.
    
    Specified by:
    
    updateChannel in interface ChannelsAsync
    
    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.

Class ChannelsAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

ChannelsAsyncClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

createChannel

deleteChannel

getChannel

listChannels

resetChannel

resumeChannel

updateChannel