Interface CloudRedisGrpc.AsyncService (2.58.0) 

public static interface CloudRedisGrpc.AsyncService

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 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

Methods

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

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

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

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

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

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

exportInstance(ExportInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void exportInstance(ExportInstanceRequest request, StreamObserver<Operation> responseObserver)

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.

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

failoverInstance(FailoverInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void failoverInstance(FailoverInstanceRequest request, StreamObserver<Operation> responseObserver)

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

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

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets the details of a specific Redis instance.

Parameters
Name Description
request GetInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Instance>

getInstanceAuthString(GetInstanceAuthStringRequest request, StreamObserver<InstanceAuthString> responseObserver)

public default void getInstanceAuthString(GetInstanceAuthStringRequest request, StreamObserver<InstanceAuthString> responseObserver)

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.

Parameters
Name Description
request GetInstanceAuthStringRequest
responseObserver io.grpc.stub.StreamObserver<InstanceAuthString>

importInstance(ImportInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void importInstance(ImportInstanceRequest request, StreamObserver<Operation> responseObserver)

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.

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

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

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

rescheduleMaintenance(RescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

public default void rescheduleMaintenance(RescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

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

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

updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

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.

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

upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void upgradeInstance(UpgradeInstanceRequest request, StreamObserver<Operation> responseObserver)

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

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