com.google.cloud.redis.cluster.v1

Class CloudRedisClusterGrpc.CloudRedisClusterBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<CloudRedisClusterGrpc.CloudRedisClusterBlockingStub>

com.google.cloud.redis.cluster.v1.CloudRedisClusterGrpc.CloudRedisClusterBlockingStub

Enclosing class:

CloudRedisClusterGrpc

public static final class CloudRedisClusterGrpc.CloudRedisClusterBlockingStub
extends io.grpc.stub.AbstractBlockingStub<CloudRedisClusterGrpc.CloudRedisClusterBlockingStub>

A stub to allow clients to do synchronous 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
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected CloudRedisClusterGrpc.CloudRedisClusterBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.longrunning.Operation	createCluster(CreateClusterRequest request) Creates a Redis cluster based on the specified properties.
com.google.longrunning.Operation	deleteCluster(DeleteClusterRequest request) Deletes a specific Redis cluster.
Cluster	getCluster(GetClusterRequest request) Gets the details of a specific Redis cluster.
ListClustersResponse	listClusters(ListClustersRequest request) Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
com.google.longrunning.Operation	updateCluster(UpdateClusterRequest request) Updates the metadata and configuration of a specific Redis cluster.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected CloudRedisClusterGrpc.CloudRedisClusterBlockingStub build(io.grpc.Channel channel,
                                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<CloudRedisClusterGrpc.CloudRedisClusterBlockingStub>

listClusters

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

getCluster

public Cluster getCluster(GetClusterRequest request)

 Gets the details of a specific Redis cluster.
 

updateCluster

public com.google.longrunning.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.
 

deleteCluster

public com.google.longrunning.Operation deleteCluster(DeleteClusterRequest request)

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

createCluster

public com.google.longrunning.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.