Class CloudRedisClusterGrpc.CloudRedisClusterFutureStub (0.29.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

Inheritance

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

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(java.time.Duration)

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.withOnReadyThreshold(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

backupCluster(BackupClusterRequest request)

public ListenableFuture<Operation> backupCluster(BackupClusterRequest request)

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Parameter
Name	Description
`request`	`BackupClusterRequest`

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

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>`

deleteBackup(DeleteBackupRequest request)

public ListenableFuture<Operation> deleteBackup(DeleteBackupRequest request)

Deletes a specific backup.

Parameter
Name	Description
`request`	`DeleteBackupRequest`

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>`

exportBackup(ExportBackupRequest request)

public ListenableFuture<Operation> exportBackup(ExportBackupRequest request)

Exports a specific backup to a customer target Cloud Storage URI.

Parameter
Name	Description
`request`	`ExportBackupRequest`

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

getBackup(GetBackupRequest request)

public ListenableFuture<Backup> getBackup(GetBackupRequest request)

Gets the details of a specific backup.

Parameter
Name	Description
`request`	`GetBackupRequest`

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

getBackupCollection(GetBackupCollectionRequest request)

public ListenableFuture<BackupCollection> getBackupCollection(GetBackupCollectionRequest request)

Get a backup collection.

Parameter
Name	Description
`request`	`GetBackupCollectionRequest`

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

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>`

listBackupCollections(ListBackupCollectionsRequest request)

public ListenableFuture<ListBackupCollectionsResponse> listBackupCollections(ListBackupCollectionsRequest request)

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. 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`	`ListBackupCollectionsRequest`

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

listBackups(ListBackupsRequest request)

public ListenableFuture<ListBackupsResponse> listBackups(ListBackupsRequest request)

Lists all backups owned by a backup collection.

Parameter
Name	Description
`request`	`ListBackupsRequest`

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

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>`

rescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request)

public ListenableFuture<Operation> rescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request)

Reschedules upcoming maintenance event.

Parameter
Name	Description
`request`	`RescheduleClusterMaintenanceRequest`

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

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>`