com.oracle.bmc.redis

Interface RedisClusterAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RedisClusterAsyncClient

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

Use the OCI Cache API to create and manage clusters. A cluster is a memory-based storage solution. For more information, see OCI Cache.

Method Summary

Modifier and Type	Method and Description
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.
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.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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<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	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<UpdateRedisClusterResponse>	updateRedisCluster(UpdateRedisClusterRequest request, AsyncHandler<UpdateRedisClusterRequest,UpdateRedisClusterResponse> handler) Updates the specified OCI Cache cluster.
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

cancelWorkRequest

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

Cancels the specified work request.

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets the list of all nodes in a cluster.

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

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

Lists the OCI Cache clusters in the specified compartment. A cluster is a memory-based storage solution. For more information, see OCI Cache.

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

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

Returns a list of errors for a given work request.

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

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

Returns a list of logs for a given work request.

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

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

Lists the work requests in a compartment.

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

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

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

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.