Class CloudRedisGrpc.CloudRedisFutureStub (2.47.0)

public static final class CloudRedisGrpc.CloudRedisFutureStub extends AbstractFutureStub<CloudRedisGrpc.CloudRedisFutureStub>

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

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > CloudRedisGrpc.CloudRedisFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected CloudRedisGrpc.CloudRedisFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`CloudRedisGrpc.CloudRedisFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createInstance(CreateInstanceRequest request)

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

Parameter
Name	Description
`request`	`CreateInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteInstance(DeleteInstanceRequest request)

public ListenableFuture<Operation> deleteInstance(DeleteInstanceRequest request)

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

Parameter
Name	Description
`request`	`DeleteInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

exportInstance(ExportInstanceRequest request)

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

Parameter
Name	Description
`request`	`ExportInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

failoverInstance(FailoverInstanceRequest request)

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

Parameter
Name	Description
`request`	`FailoverInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Gets the details of a specific Redis instance.

Parameter
Name	Description
`request`	`GetInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Instance>`

getInstanceAuthString(GetInstanceAuthStringRequest request)

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

Parameter
Name	Description
`request`	`GetInstanceAuthStringRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<InstanceAuthString>`

importInstance(ImportInstanceRequest request)

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

Parameter
Name	Description
`request`	`ImportInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

listInstances(ListInstancesRequest request)

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

Parameter
Name	Description
`request`	`ListInstancesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>`

rescheduleMaintenance(RescheduleMaintenanceRequest request)

public ListenableFuture<Operation> rescheduleMaintenance(RescheduleMaintenanceRequest request)

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

Parameter
Name	Description
`request`	`RescheduleMaintenanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateInstance(UpdateInstanceRequest request)

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

Parameter
Name	Description
`request`	`UpdateInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

upgradeInstance(UpgradeInstanceRequest request)

public ListenableFuture<Operation> upgradeInstance(UpgradeInstanceRequest request)

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

Parameter
Name	Description
`request`	`UpgradeInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`