Class CloudRedisClusterGrpc.CloudRedisClusterFutureStub (0.18.0)

public static final class CloudRedisClusterGrpc.CloudRedisClusterFutureStub extends AbstractFutureStub<CloudRedisClusterGrpc.CloudRedisClusterFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service CloudRedisCluster.

Configures and manages Cloud Memorystore for Redis clusters Google Cloud Memorystore for Redis Cluster The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis clusters:

  • The service works with a collection of cloud projects, named: /projects/*
  • Each project has a collection of available locations, named: /locations/*
  • Each location has a collection of Redis clusters, named: /clusters/*
  • As such, Redis clusters are resources of the form: /projects/{project_id}/locations/{location_id}/clusters/{instance_id} Note that location_id must be a GCP region; for example:
  • projects/redpepper-1290/locations/us-central1/clusters/my-redis We use API version selector for Flex APIs
  • The versioning strategy is release-based versioning
  • Our backend CLH only deals with the superset version (called v1main)
  • Existing backend for Redis Gen1 and MRR is not touched.
  • More details in go/redis-flex-api-versioning

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudRedisClusterGrpc.CloudRedisClusterFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected CloudRedisClusterGrpc.CloudRedisClusterFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
CloudRedisClusterGrpc.CloudRedisClusterFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createCluster(CreateClusterRequest request)

public ListenableFuture<Operation> createCluster(CreateClusterRequest request)

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameter
Name Description
request CreateClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteCluster(DeleteClusterRequest request)

public ListenableFuture<Operation> deleteCluster(DeleteClusterRequest request)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameter
Name Description
request DeleteClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getCluster(GetClusterRequest request)

public ListenableFuture<Cluster> getCluster(GetClusterRequest request)

Gets the details of a specific Redis cluster.

Parameter
Name Description
request GetClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Cluster>

getClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request)

public ListenableFuture<CertificateAuthority> getClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request)

Gets the details of certificate authority information for Redis cluster.

Parameter
Name Description
request GetClusterCertificateAuthorityRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CertificateAuthority>

listClusters(ListClustersRequest request)

public ListenableFuture<ListClustersResponse> listClusters(ListClustersRequest request)

Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format:

  • projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.
Parameter
Name Description
request ListClustersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListClustersResponse>

updateCluster(UpdateClusterRequest request)

public ListenableFuture<Operation> updateCluster(UpdateClusterRequest request)

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameter
Name Description
request UpdateClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>