com.google.cloud.redis.v1

Class CloudRedisGrpc.CloudRedisFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<CloudRedisGrpc.CloudRedisFutureStub>

com.google.cloud.redis.v1.CloudRedisGrpc.CloudRedisFutureStub

Enclosing class:

CloudRedisGrpc

public static final class CloudRedisGrpc.CloudRedisFutureStub
extends io.grpc.stub.AbstractFutureStub<CloudRedisGrpc.CloudRedisFutureStub>

 Configures and manages Cloud Memorystore for Redis instances
 Google Cloud Memorystore for Redis v1
 The `redis.googleapis.com` service implements the Google Cloud Memorystore
 for Redis API and defines the following resource model for managing Redis
 instances:
 * 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 instances, named: `/instances/*`
 * As such, Redis instances are resources of the form:
   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
 Note that location_id must be referring to a GCP `region`; for example:
 * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
 

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 CloudRedisGrpc.CloudRedisFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createInstance(CreateInstanceRequest request) Creates a Redis instance based on the specified tier and memory size.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteInstance(DeleteInstanceRequest request) Deletes a specific Redis instance.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	exportInstance(ExportInstanceRequest request) Export Redis instance data into a Redis RDB format file in Cloud Storage.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	failoverInstance(FailoverInstanceRequest request) Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
com.google.common.util.concurrent.ListenableFuture<Instance>	getInstance(GetInstanceRequest request) Gets the details of a specific Redis instance.
com.google.common.util.concurrent.ListenableFuture<InstanceAuthString>	getInstanceAuthString(GetInstanceAuthStringRequest request) Gets the AUTH string for a Redis instance.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	importInstance(ImportInstanceRequest request) Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>	listInstances(ListInstancesRequest request) Lists all Redis instances owned by a project in either the specified location (region) or all locations.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	rescheduleMaintenance(RescheduleMaintenanceRequest request) Reschedule maintenance for a given instance in a given project and location.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateInstance(UpdateInstanceRequest request) Updates the metadata and configuration of a specific Redis instance.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	upgradeInstance(UpgradeInstanceRequest request) Upgrades Redis instance to the newer Redis version specified in the request.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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 CloudRedisGrpc.CloudRedisFutureStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<CloudRedisGrpc.CloudRedisFutureStub>

listInstances

public com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

 Lists all Redis instances 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.
 

getInstance

public com.google.common.util.concurrent.ListenableFuture<Instance> getInstance(GetInstanceRequest request)

 Gets the details of a specific Redis instance.
 

getInstanceAuthString

public com.google.common.util.concurrent.ListenableFuture<InstanceAuthString> getInstanceAuthString(GetInstanceAuthStringRequest request)

 Gets the AUTH string for a Redis instance. If AUTH is not enabled for the
 instance the response will be empty. This information is not included in
 the details returned to GetInstance.
 

createInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createInstance(CreateInstanceRequest request)

 Creates a Redis instance based on the specified tier and memory size.
 By default, the instance is accessible from the project's
 [default network](https://cloud.google.com/vpc/docs/vpc).
 The creation is executed asynchronously and callers may check the returned
 operation to track its progress. Once the operation is completed the Redis
 instance will be fully functional. Completed longrunning.Operation will
 contain the new instance object in the response field.
 The returned operation is automatically deleted after a few hours, so there
 is no need to call DeleteOperation.
 

updateInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateInstance(UpdateInstanceRequest request)

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

upgradeInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> upgradeInstance(UpgradeInstanceRequest request)

 Upgrades Redis instance to the newer Redis version specified in the
 request.
 

importInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> importInstance(ImportInstanceRequest request)

 Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
 Redis may stop serving during this operation. Instance state will be
 IMPORTING for entire operation. When complete, the instance will contain
 only data from the imported file.
 The returned operation is automatically deleted after a few hours, so
 there is no need to call DeleteOperation.
 

exportInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> exportInstance(ExportInstanceRequest request)

 Export Redis instance data into a Redis RDB format file in Cloud Storage.
 Redis will continue serving during this operation.
 The returned operation is automatically deleted after a few hours, so
 there is no need to call DeleteOperation.
 

failoverInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> failoverInstance(FailoverInstanceRequest request)

 Initiates a failover of the primary node to current replica node for a
 specific STANDARD tier Cloud Memorystore for Redis instance.
 

deleteInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteInstance(DeleteInstanceRequest request)

 Deletes a specific Redis instance.  Instance stops serving and data is
 deleted.
 

rescheduleMaintenance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> rescheduleMaintenance(RescheduleMaintenanceRequest request)

 Reschedule maintenance for a given instance in a given project and
 location.