Interface CloudRedisClusterGrpc.AsyncService
- All Known Implementing Classes:
CloudRedisClusterGrpc.CloudRedisClusterImplBase
- Enclosing class:
- CloudRedisClusterGrpc
public static interface CloudRedisClusterGrpc.AsyncService
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`
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidbackupCluster(BackupClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Backup Redis Cluster.default voidcreateCluster(CreateClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Creates a Redis cluster based on the specified properties.default voiddeleteBackup(DeleteBackupRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a specific backup.default voiddeleteCluster(DeleteClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a specific Redis cluster.default voidexportBackup(ExportBackupRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Exports a specific backup to a customer target Cloud Storage URI.default voidgetBackup(GetBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver) Gets the details of a specific backup.default voidgetBackupCollection(GetBackupCollectionRequest request, io.grpc.stub.StreamObserver<BackupCollection> responseObserver) Get a backup collection.default voidgetCluster(GetClusterRequest request, io.grpc.stub.StreamObserver<Cluster> responseObserver) Gets the details of a specific Redis cluster.default voidgetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, io.grpc.stub.StreamObserver<CertificateAuthority> responseObserver) Gets the details of certificate authority information for Redis cluster.default voidgetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, io.grpc.stub.StreamObserver<SharedRegionalCertificateAuthority> responseObserver) Gets the details of regional certificate authority information for Redis cluster.default voidlistBackupCollections(ListBackupCollectionsRequest request, io.grpc.stub.StreamObserver<ListBackupCollectionsResponse> responseObserver) Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.default voidlistBackups(ListBackupsRequest request, io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver) Lists all backups owned by a backup collection.default voidlistClusters(ListClustersRequest request, io.grpc.stub.StreamObserver<ListClustersResponse> responseObserver) Lists all Redis clusters owned by a project in either the specified location (region) or all locations.default voidrescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Reschedules upcoming maintenance event.default voidupdateCluster(UpdateClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Updates the metadata and configuration of a specific Redis cluster.
-
Method Details
-
listClusters
default void listClusters(ListClustersRequest request, io.grpc.stub.StreamObserver<ListClustersResponse> responseObserver) 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. -
getCluster
default void getCluster(GetClusterRequest request, io.grpc.stub.StreamObserver<Cluster> responseObserver) Gets the details of a specific Redis cluster.
-
updateCluster
default void updateCluster(UpdateClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) 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.
-
deleteCluster
default void deleteCluster(DeleteClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
-
createCluster
default void createCluster(CreateClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) 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.
-
getClusterCertificateAuthority
default void getClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, io.grpc.stub.StreamObserver<CertificateAuthority> responseObserver) Gets the details of certificate authority information for Redis cluster.
-
rescheduleClusterMaintenance
default void rescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Reschedules upcoming maintenance event.
-
listBackupCollections
default void listBackupCollections(ListBackupCollectionsRequest request, io.grpc.stub.StreamObserver<ListBackupCollectionsResponse> responseObserver) 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.
-
getBackupCollection
default void getBackupCollection(GetBackupCollectionRequest request, io.grpc.stub.StreamObserver<BackupCollection> responseObserver) Get a backup collection.
-
listBackups
default void listBackups(ListBackupsRequest request, io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver) Lists all backups owned by a backup collection.
-
getBackup
default void getBackup(GetBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver) Gets the details of a specific backup.
-
deleteBackup
default void deleteBackup(DeleteBackupRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a specific backup.
-
exportBackup
default void exportBackup(ExportBackupRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Exports a specific backup to a customer target Cloud Storage URI.
-
backupCluster
default void backupCluster(BackupClusterRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) 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.
-