Package com.oracle.bmc.redis

Class RedisClusterAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.redis.RedisClusterAsyncClient

All Implemented Interfaces:

RedisClusterAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public class RedisClusterAsyncClient
extends BaseAsyncClient
implements RedisClusterAsync

Async client implementation for RedisCluster 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	Description
static class	RedisClusterAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for RedisCluster.

Constructor Summary

Constructors

Constructor	Description
RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
Future<AttachOciCacheUsersResponse>	attachOciCacheUsers(AttachOciCacheUsersRequest request, AsyncHandler<AttachOciCacheUsersRequest,AttachOciCacheUsersResponse> handler)	Attach existing OCI cache users to a redis cluster.
static RedisClusterAsyncClient.Builder	builder()	Create a builder for this client.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)	Cancels the specified work request.
Future<ChangeRedisClusterCompartmentResponse>	changeRedisClusterCompartment(ChangeRedisClusterCompartmentRequest request, AsyncHandler<ChangeRedisClusterCompartmentRequest,ChangeRedisClusterCompartmentResponse> handler)	Moves an OCI Cache cluster into a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateRedisClusterResponse>	createRedisCluster(CreateRedisClusterRequest request, AsyncHandler<CreateRedisClusterRequest,CreateRedisClusterResponse> handler)	Creates a new OCI Cache cluster.
Future<DeleteRedisClusterResponse>	deleteRedisCluster(DeleteRedisClusterRequest request, AsyncHandler<DeleteRedisClusterRequest,DeleteRedisClusterResponse> handler)	Deletes the specified OCI Cache cluster.
Future<DetachOciCacheUsersResponse>	detachOciCacheUsers(DetachOciCacheUsersRequest request, AsyncHandler<DetachOciCacheUsersRequest,DetachOciCacheUsersResponse> handler)	Detach existing OCI cache users to a redis cluster.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetRedisClusterResponse>	getRedisCluster(GetRedisClusterRequest request, AsyncHandler<GetRedisClusterRequest,GetRedisClusterResponse> handler)	Retrieves the specified OCI Cache cluster.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets the status of the work request with the given ID.
Future<ListAttachedOciCacheUsersResponse>	listAttachedOciCacheUsers(ListAttachedOciCacheUsersRequest request, AsyncHandler<ListAttachedOciCacheUsersRequest,ListAttachedOciCacheUsersResponse> handler)	Gets a list of associated OCI cache users for a redis cluster.
Future<ListRedisClusterNodesResponse>	listRedisClusterNodes(ListRedisClusterNodesRequest request, AsyncHandler<ListRedisClusterNodesRequest,ListRedisClusterNodesResponse> handler)	Gets the list of all nodes in a cluster.
Future<ListRedisClustersResponse>	listRedisClusters(ListRedisClustersRequest request, AsyncHandler<ListRedisClustersRequest,ListRedisClustersResponse> handler)	Lists the OCI Cache clusters in the specified compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Returns a list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Returns a list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateRedisClusterResponse>	updateRedisCluster(UpdateRedisClusterRequest request, AsyncHandler<UpdateRedisClusterRequest,UpdateRedisClusterResponse> handler)	Updates the specified OCI Cache cluster.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.redis.RedisClusterAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for RedisCluster.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

RedisClusterAsyncClient

@Deprecated
public RedisClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static RedisClusterAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: RedisClusterAsync

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 RedisClusterAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RedisClusterAsync

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 RedisClusterAsync

Parameters:

regionId - The public region ID.

attachOciCacheUsers

public Future<AttachOciCacheUsersResponse> attachOciCacheUsers(AttachOciCacheUsersRequest request,
                                                               AsyncHandler<AttachOciCacheUsersRequest,AttachOciCacheUsersResponse> handler)

Description copied from interface: RedisClusterAsync

Attach existing OCI cache users to a redis cluster.

Specified by:

attachOciCacheUsers in interface RedisClusterAsync

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.

cancelWorkRequest

public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Description copied from interface: RedisClusterAsync

Cancels the specified work request.

Specified by:

cancelWorkRequest in interface RedisClusterAsync

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.

changeRedisClusterCompartment

public Future<ChangeRedisClusterCompartmentResponse> changeRedisClusterCompartment(ChangeRedisClusterCompartmentRequest request,
                                                                                   AsyncHandler<ChangeRedisClusterCompartmentRequest,ChangeRedisClusterCompartmentResponse> handler)

Description copied from interface: RedisClusterAsync

Moves an OCI Cache cluster into a different compartment within the same tenancy.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

changeRedisClusterCompartment in interface RedisClusterAsync

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.

createRedisCluster

public Future<CreateRedisClusterResponse> createRedisCluster(CreateRedisClusterRequest request,
                                                             AsyncHandler<CreateRedisClusterRequest,CreateRedisClusterResponse> handler)

Description copied from interface: RedisClusterAsync

Creates a new OCI Cache cluster.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

createRedisCluster in interface RedisClusterAsync

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.

deleteRedisCluster

public Future<DeleteRedisClusterResponse> deleteRedisCluster(DeleteRedisClusterRequest request,
                                                             AsyncHandler<DeleteRedisClusterRequest,DeleteRedisClusterResponse> handler)

Description copied from interface: RedisClusterAsync

Deletes the specified OCI Cache cluster.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

deleteRedisCluster in interface RedisClusterAsync

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.

detachOciCacheUsers

public Future<DetachOciCacheUsersResponse> detachOciCacheUsers(DetachOciCacheUsersRequest request,
                                                               AsyncHandler<DetachOciCacheUsersRequest,DetachOciCacheUsersResponse> handler)

Description copied from interface: RedisClusterAsync

Detach existing OCI cache users to a redis cluster.

Specified by:

detachOciCacheUsers in interface RedisClusterAsync

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.

getRedisCluster

public Future<GetRedisClusterResponse> getRedisCluster(GetRedisClusterRequest request,
                                                       AsyncHandler<GetRedisClusterRequest,GetRedisClusterResponse> handler)

Description copied from interface: RedisClusterAsync

Retrieves the specified OCI Cache cluster.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

getRedisCluster in interface RedisClusterAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: RedisClusterAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface RedisClusterAsync

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.

listAttachedOciCacheUsers

public Future<ListAttachedOciCacheUsersResponse> listAttachedOciCacheUsers(ListAttachedOciCacheUsersRequest request,
                                                                           AsyncHandler<ListAttachedOciCacheUsersRequest,ListAttachedOciCacheUsersResponse> handler)

Description copied from interface: RedisClusterAsync

Gets a list of associated OCI cache users for a redis cluster.

Specified by:

listAttachedOciCacheUsers in interface RedisClusterAsync

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.

listRedisClusterNodes

public Future<ListRedisClusterNodesResponse> listRedisClusterNodes(ListRedisClusterNodesRequest request,
                                                                   AsyncHandler<ListRedisClusterNodesRequest,ListRedisClusterNodesResponse> handler)

Description copied from interface: RedisClusterAsync

Gets the list of all nodes in a cluster.

Specified by:

listRedisClusterNodes in interface RedisClusterAsync

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.

listRedisClusters

public Future<ListRedisClustersResponse> listRedisClusters(ListRedisClustersRequest request,
                                                           AsyncHandler<ListRedisClustersRequest,ListRedisClustersResponse> handler)

Description copied from interface: RedisClusterAsync

Lists the OCI Cache clusters in the specified compartment.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

listRedisClusters in interface RedisClusterAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: RedisClusterAsync

Returns a list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface RedisClusterAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: RedisClusterAsync

Returns a list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface RedisClusterAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: RedisClusterAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface RedisClusterAsync

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.

updateRedisCluster

public Future<UpdateRedisClusterResponse> updateRedisCluster(UpdateRedisClusterRequest request,
                                                             AsyncHandler<UpdateRedisClusterRequest,UpdateRedisClusterResponse> handler)

Description copied from interface: RedisClusterAsync

Updates the specified OCI Cache cluster.

A cluster is a memory-based storage solution. For more information, see OCI Cache.

Specified by:

updateRedisCluster in interface RedisClusterAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)