Interface CloudRedisClusterGrpc.AsyncService (0.17.0) 

public static interface CloudRedisClusterGrpc.AsyncService

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

Methods

createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

public default void createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request CreateClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver)

public default void deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

public default void getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

Gets the details of a specific Redis cluster.

Parameters
Name Description
request GetClusterRequest
responseObserver io.grpc.stub.StreamObserver<Cluster>

listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

public default void listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

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.
Parameters
Name Description
request ListClustersRequest
responseObserver io.grpc.stub.StreamObserver<ListClustersResponse>

updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver)

public default void updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request UpdateClusterRequest
responseObserver io.grpc.stub.StreamObserver<Operation>