# Google Cloud Memorystore for Redis V1 API - Class Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub (v1.7.0)

1.7.0 (latest) 1.6.0 1.5.1 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.6.0 0.5.0 0.4.2 0.3.0 0.2.2 0.1.0 Reference documentation and code samples for the Google Cloud Memorystore for Redis V1 API class Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub.

REST service stub for the CloudRedisCluster service.
Service stub contains baseline method implementations
including transcoding, making the REST call, and deserialing the response.

## Inherits

- Object

## Methods

### #backup_cluster

    def backup_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the backup_cluster REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::BackupClusterRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-BackupClusterRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #create_cluster

    def create_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_cluster REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::CreateClusterRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-CreateClusterRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #delete_backup

    def delete_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_backup REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::DeleteBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-DeleteBackupRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #delete_cluster

    def delete_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_cluster REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::DeleteClusterRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-DeleteClusterRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #endpoint

    def endpoint() -> String

The effective endpoint
**Returns**

- (String)

### #export_backup

    def export_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the export_backup REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::ExportBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ExportBackupRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_backup

    def get_backup(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::Backup

Baseline implementation for the get_backup REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::GetBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-GetBackupRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::Backup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-Backup))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::Backup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-Backup)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_backup_collection

    def get_backup_collection(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::BackupCollection

Baseline implementation for the get_backup_collection REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::GetBackupCollectionRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-GetBackupCollectionRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::BackupCollection](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-BackupCollection))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::BackupCollection](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-BackupCollection)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_cluster

    def get_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::Cluster

Baseline implementation for the get_cluster REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::GetClusterRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-GetClusterRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::Cluster](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-Cluster))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::Cluster](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-Cluster)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_cluster_certificate_authority

    def get_cluster_certificate_authority(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::CertificateAuthority

Baseline implementation for the get_cluster_certificate_authority REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::GetClusterCertificateAuthorityRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-GetClusterCertificateAuthorityRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::CertificateAuthority](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-CertificateAuthority))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::CertificateAuthority](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-CertificateAuthority)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_shared_regional_certificate_authority

    def get_shared_regional_certificate_authority(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::SharedRegionalCertificateAuthority

Baseline implementation for the get_shared_regional_certificate_authority REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::GetSharedRegionalCertificateAuthorityRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-GetSharedRegionalCertificateAuthorityRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::SharedRegionalCertificateAuthority](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-SharedRegionalCertificateAuthority))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::SharedRegionalCertificateAuthority](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-SharedRegionalCertificateAuthority)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #list_backup_collections

    def list_backup_collections(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::ListBackupCollectionsResponse

Baseline implementation for the list_backup_collections REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::ListBackupCollectionsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupCollectionsRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::ListBackupCollectionsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupCollectionsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::ListBackupCollectionsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupCollectionsResponse)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #list_backups

    def list_backups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::ListBackupsResponse

Baseline implementation for the list_backups REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::ListBackupsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupsRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::ListBackupsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::ListBackupsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListBackupsResponse)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #list_clusters

    def list_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Redis::Cluster::V1::ListClustersResponse

Baseline implementation for the list_clusters REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::ListClustersRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListClustersRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Redis::Cluster::V1::ListClustersResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListClustersResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Redis::Cluster::V1::ListClustersResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-ListClustersResponse)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #logger

    def logger(stub: false) -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #reschedule_cluster_maintenance

    def reschedule_cluster_maintenance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the reschedule_cluster_maintenance REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::RescheduleClusterMaintenanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-RescheduleClusterMaintenanceRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)

### #update_cluster

    def update_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_cluster REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Redis::Cluster::V1::UpdateClusterRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Cloud-Redis-Cluster-V1-UpdateClusterRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis-cluster-v1/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)