Struct CloudRedisCluster 

pub struct CloudRedisCluster { /* private fields */ }

Implements a client for the Google Cloud Memorystore for Redis API.

Example

let client = CloudRedisCluster::builder().build().await?;
// use `client` to make requests to the Google Cloud Memorystore for Redis API.

Service Description

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

Configuration

To configure CloudRedisCluster use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://redis.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

CloudRedisCluster holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap CloudRedisCluster in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl CloudRedisCluster

pub fn builder() -> ClientBuilder

Returns a builder for CloudRedisCluster.

let client = CloudRedisCluster::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: CloudRedisCluster + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_clusters(&self) -> ListClusters

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.

pub fn get_cluster(&self) -> GetCluster

Gets the details of a specific Redis cluster.

pub fn update_cluster(&self) -> UpdateCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_cluster(&self) -> DeleteCluster

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_cluster(&self) -> CreateCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_cluster_certificate_authority( &self, ) -> GetClusterCertificateAuthority

Gets the details of certificate authority information for Redis cluster.

pub fn reschedule_cluster_maintenance(&self) -> RescheduleClusterMaintenance

Reschedules upcoming maintenance event.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_backup_collections(&self) -> ListBackupCollections

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.

pub fn get_backup_collection(&self) -> GetBackupCollection

Get a backup collection.

pub fn list_backups(&self) -> ListBackups

Lists all backups owned by a backup collection.

pub fn get_backup(&self) -> GetBackup

Gets the details of a specific backup.

pub fn delete_backup(&self) -> DeleteBackup

Deletes a specific backup.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn export_backup(&self) -> ExportBackup

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn backup_cluster(&self) -> BackupCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for CloudRedisCluster

fn clone(&self) -> CloudRedisCluster

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloudRedisCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.