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 classRedisClusterClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for RedisCluster.
-
Constructor Summary
Constructors Constructor Description RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttachOciCacheUsersResponseattachOciCacheUsers(AttachOciCacheUsersRequest request)Attach existing OCI cache users to a redis cluster.static RedisClusterClient.Builderbuilder()Create a builder for this client.CancelWorkRequestResponsecancelWorkRequest(CancelWorkRequestRequest request)Cancels the specified work request.ChangeRedisClusterCompartmentResponsechangeRedisClusterCompartment(ChangeRedisClusterCompartmentRequest request)Moves an OCI Cache cluster into a different compartment within the same tenancy.voidclose()CreateRedisClusterResponsecreateRedisCluster(CreateRedisClusterRequest request)Creates a new OCI Cache cluster.DeleteRedisClusterResponsedeleteRedisCluster(DeleteRedisClusterRequest request)Deletes the specified OCI Cache cluster.DetachOciCacheUsersResponsedetachOciCacheUsers(DetachOciCacheUsersRequest request)Detach existing OCI cache users to a redis cluster.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.RedisClusterPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetRedisClusterResponsegetRedisCluster(GetRedisClusterRequest request)Retrieves the specified OCI Cache cluster.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.RedisClusterWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given ID.ListAttachedOciCacheUsersResponselistAttachedOciCacheUsers(ListAttachedOciCacheUsersRequest request)Gets a list of associated OCI cache users for a redis cluster.ListRedisClusterNodesResponselistRedisClusterNodes(ListRedisClusterNodesRequest request)Gets the list of all nodes in a cluster.ListRedisClustersResponselistRedisClusters(ListRedisClustersRequest request)Lists the OCI Cache clusters in the specified compartment.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Returns a list of errors for a given work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Returns a list of logs for a given work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateRedisClusterResponseupdateRedisCluster(UpdateRedisClusterRequest request)Updates the specified OCI Cache cluster.voiduseRealmSpecificEndpointTemplate(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
-
-
-
-
Constructor Detail
-
RedisClusterClient
@Deprecated public RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
RedisClusterClient
@Deprecated public RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
RedisClusterClient
@Deprecated public RedisClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
RedisClusterClient
@Deprecated public RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
RedisClusterClient
@Deprecated public RedisClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRedisClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:RedisClusterSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceRedisCluster- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:RedisClusterSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceRedisCluster- Parameters:
regionId- The public region ID.
-
attachOciCacheUsers
public AttachOciCacheUsersResponse attachOciCacheUsers(AttachOciCacheUsersRequest request)
Description copied from interface:RedisClusterAttach existing OCI cache users to a redis cluster.- Specified by:
attachOciCacheUsersin interfaceRedisCluster- 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:RedisClusterCancels the specified work request.- Specified by:
cancelWorkRequestin interfaceRedisCluster- 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:RedisClusterMoves 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:
changeRedisClusterCompartmentin interfaceRedisCluster- 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:RedisClusterCreates a new OCI Cache cluster.A cluster is a memory-based storage solution. For more information, see OCI Cache.
- Specified by:
createRedisClusterin interfaceRedisCluster- 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:RedisClusterDeletes the specified OCI Cache cluster.A cluster is a memory-based storage solution. For more information, see OCI Cache.
- Specified by:
deleteRedisClusterin interfaceRedisCluster- 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:RedisClusterDetach existing OCI cache users to a redis cluster.- Specified by:
detachOciCacheUsersin interfaceRedisCluster- 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:RedisClusterRetrieves the specified OCI Cache cluster.A cluster is a memory-based storage solution. For more information, see OCI Cache.
- Specified by:
getRedisClusterin interfaceRedisCluster- 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:RedisClusterGets the status of the work request with the given ID.- Specified by:
getWorkRequestin interfaceRedisCluster- 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:RedisClusterGets a list of associated OCI cache users for a redis cluster.- Specified by:
listAttachedOciCacheUsersin interfaceRedisCluster- 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:RedisClusterGets the list of all nodes in a cluster.- Specified by:
listRedisClusterNodesin interfaceRedisCluster- 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:RedisClusterLists the OCI Cache clusters in the specified compartment.A cluster is a memory-based storage solution. For more information, see OCI Cache.
- Specified by:
listRedisClustersin interfaceRedisCluster- 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:RedisClusterReturns a list of errors for a given work request.- Specified by:
listWorkRequestErrorsin interfaceRedisCluster- 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:RedisClusterReturns a list of logs for a given work request.- Specified by:
listWorkRequestLogsin interfaceRedisCluster- 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:RedisClusterLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceRedisCluster- 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:RedisClusterUpdates the specified OCI Cache cluster.A cluster is a memory-based storage solution. For more information, see OCI Cache.
- Specified by:
updateRedisClusterin interfaceRedisCluster- 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:RedisClusterGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceRedisCluster- Returns:
- The service waiters.
-
getPaginators
public RedisClusterPaginators getPaginators()
Description copied from interface:RedisClusterGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceRedisCluster- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-