Package com.google.cloud.redis.v1

Interface CloudRedisGrpc.AsyncService

  • All Known Implementing Classes:
    CloudRedisGrpc.CloudRedisImplBase
    Enclosing class:
    CloudRedisGrpc
    public static interface CloudRedisGrpc.AsyncService
     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`

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void createInstance​(CreateInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Creates a Redis instance based on the specified tier and memory size.
      default void deleteInstance​(DeleteInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Deletes a specific Redis instance.
      default void exportInstance​(ExportInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Export Redis instance data into a Redis RDB format file in Cloud Storage.
      default void failoverInstance​(FailoverInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
      default void getInstance​(GetInstanceRequest request, io.grpc.stub.StreamObserver<Instance> responseObserver)
      Gets the details of a specific Redis instance.
      default void getInstanceAuthString​(GetInstanceAuthStringRequest request, io.grpc.stub.StreamObserver<InstanceAuthString> responseObserver)
      Gets the AUTH string for a Redis instance.
      default void importInstance​(ImportInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
      default void listInstances​(ListInstancesRequest request, io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver)
      Lists all Redis instances owned by a project in either the specified location (region) or all locations.
      default void rescheduleMaintenance​(RescheduleMaintenanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Reschedule maintenance for a given instance in a given project and location.
      default void updateInstance​(UpdateInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Updates the metadata and configuration of a specific Redis instance.
      default void upgradeInstance​(UpgradeInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Upgrades Redis instance to the newer Redis version specified in the request.

    • Method Detail

      • listInstances

        default void listInstances​(ListInstancesRequest request,
                           io.grpc.stub.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.

      • getInstance

        default void getInstance​(GetInstanceRequest request,
                         io.grpc.stub.StreamObserver<Instance> responseObserver)
         Gets the details of a specific Redis instance.

      • getInstanceAuthString

        default void getInstanceAuthString​(GetInstanceAuthStringRequest request,
                                   io.grpc.stub.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.

      • createInstance

        default void createInstance​(CreateInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.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](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

        default void updateInstance​(UpdateInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.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.

      • upgradeInstance

        default void upgradeInstance​(UpgradeInstanceRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Upgrades Redis instance to the newer Redis version specified in the
 request.

      • importInstance

        default void importInstance​(ImportInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.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.

      • exportInstance

        default void exportInstance​(ExportInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.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.

      • failoverInstance

        default void failoverInstance​(FailoverInstanceRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Initiates a failover of the primary node to current replica node for a
 specific STANDARD tier Cloud Memorystore for Redis instance.

      • deleteInstance

        default void deleteInstance​(DeleteInstanceRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Deletes a specific Redis instance.  Instance stops serving and data is
 deleted.

      • rescheduleMaintenance

        default void rescheduleMaintenance​(RescheduleMaintenanceRequest request,
                                   io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Reschedule maintenance for a given instance in a given project and
 location.