Package com.oracle.bmc.redis

Class RedisClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.redis.RedisClusterClient

All Implemented Interfaces:

RedisCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public class RedisClusterClient
extends BaseSyncClient
implements RedisCluster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisClusterClient.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
RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
AttachOciCacheUsersResponse	attachOciCacheUsers(AttachOciCacheUsersRequest request)	Attach existing OCI cache users to a redis cluster.
static RedisClusterClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancels the specified work request.
ChangeRedisClusterCompartmentResponse	changeRedisClusterCompartment(ChangeRedisClusterCompartmentRequest request)	Moves an OCI Cache cluster into a different compartment within the same tenancy.
void	close()
CreateRedisClusterResponse	createRedisCluster(CreateRedisClusterRequest request)	Creates a new OCI Cache cluster.
DeleteRedisClusterResponse	deleteRedisCluster(DeleteRedisClusterRequest request)	Deletes the specified OCI Cache cluster.
DetachOciCacheUsersResponse	detachOciCacheUsers(DetachOciCacheUsersRequest request)	Detach existing OCI cache users to a redis cluster.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
RedisClusterPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRedisClusterResponse	getRedisCluster(GetRedisClusterRequest request)	Retrieves the specified OCI Cache cluster.
RedisClusterWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListAttachedOciCacheUsersResponse	listAttachedOciCacheUsers(ListAttachedOciCacheUsersRequest request)	Gets a list of associated OCI cache users for a redis cluster.
ListRedisClusterNodesResponse	listRedisClusterNodes(ListRedisClusterNodesRequest request)	Gets the list of all nodes in a cluster.
ListRedisClustersResponse	listRedisClusters(ListRedisClustersRequest request)	Lists the OCI Cache clusters in the specified compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Returns a list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Returns a list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	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.
UpdateRedisClusterResponse	updateRedisCluster(UpdateRedisClusterRequest request)	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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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

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

RedisClusterClient

@Deprecated
public RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

RedisClusterClient

@Deprecated
public RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

RedisClusterClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

RedisClusterClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RedisClusterClient

@Deprecated
public RedisClusterClient(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 RedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RedisClusterClient

@Deprecated
public RedisClusterClient(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 RedisClusterClient.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)

RedisClusterClient

@Deprecated
public RedisClusterClient(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 RedisClusterClient.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

RedisClusterClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see RedisClusterClient.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

executorService - RedisClusterClient.Builder.executorService

Method Detail

builder

public static RedisClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

regionId - The public region ID.

attachOciCacheUsers

public AttachOciCacheUsersResponse attachOciCacheUsers(AttachOciCacheUsersRequest request)

Description copied from interface: RedisCluster

Attach existing OCI cache users to a redis cluster.

Specified by:

attachOciCacheUsers in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: RedisCluster

Cancels the specified work request.

Specified by:

cancelWorkRequest in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeRedisClusterCompartment

public ChangeRedisClusterCompartmentResponse changeRedisClusterCompartment(ChangeRedisClusterCompartmentRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRedisCluster

public CreateRedisClusterResponse createRedisCluster(CreateRedisClusterRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRedisCluster

public DeleteRedisClusterResponse deleteRedisCluster(DeleteRedisClusterRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachOciCacheUsers

public DetachOciCacheUsersResponse detachOciCacheUsers(DetachOciCacheUsersRequest request)

Description copied from interface: RedisCluster

Detach existing OCI cache users to a redis cluster.

Specified by:

detachOciCacheUsers in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRedisCluster

public GetRedisClusterResponse getRedisCluster(GetRedisClusterRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: RedisCluster

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

Specified by:

getWorkRequest in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAttachedOciCacheUsers

public ListAttachedOciCacheUsersResponse listAttachedOciCacheUsers(ListAttachedOciCacheUsersRequest request)

Description copied from interface: RedisCluster

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

Specified by:

listAttachedOciCacheUsers in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRedisClusterNodes

public ListRedisClusterNodesResponse listRedisClusterNodes(ListRedisClusterNodesRequest request)

Description copied from interface: RedisCluster

Gets the list of all nodes in a cluster.

Specified by:

listRedisClusterNodes in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRedisClusters

public ListRedisClustersResponse listRedisClusters(ListRedisClustersRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: RedisCluster

Returns a list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: RedisCluster

Returns a list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: RedisCluster

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRedisCluster

public UpdateRedisClusterResponse updateRedisCluster(UpdateRedisClusterRequest request)

Description copied from interface: RedisCluster

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 RedisCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public RedisClusterWaiters getWaiters()

Description copied from interface: RedisCluster

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

Specified by:

getWaiters in interface RedisCluster

Returns:

The service waiters.

getPaginators

public RedisClusterPaginators getPaginators()

Description copied from interface: RedisCluster

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.

Specified by:

getPaginators in interface RedisCluster

Returns:

The service paginators.

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()