Struct google_api_proto::google::cloud::redis::cluster::v1::cloud_redis_cluster_client::CloudRedisClusterClient

pub struct CloudRedisClusterClient<T> { /* private fields */ }

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

We use API version selector for Flex APIs

• The versioning strategy is release-based versioning
• Our backend CLH only deals with the superset version (called v1main)
• Existing backend for Redis Gen1 and MRR is not touched.
• More details in go/redis-flex-api-versioning

Implementations

impl<T> CloudRedisClusterClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> CloudRedisClusterClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn list_clusters( &mut self, request: impl IntoRequest<ListClustersRequest>, ) -> Result<Response<ListClustersResponse>, Status>

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 async fn get_cluster( &mut self, request: impl IntoRequest<GetClusterRequest>, ) -> Result<Response<Cluster>, Status>

Gets the details of a specific Redis cluster.

pub async fn update_cluster( &mut self, request: impl IntoRequest<UpdateClusterRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn delete_cluster( &mut self, request: impl IntoRequest<DeleteClusterRequest>, ) -> Result<Response<Operation>, Status>

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

pub async fn create_cluster( &mut self, request: impl IntoRequest<CreateClusterRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn get_cluster_certificate_authority( &mut self, request: impl IntoRequest<GetClusterCertificateAuthorityRequest>, ) -> Result<Response<CertificateAuthority>, Status>

Gets the details of certificate authority information for Redis cluster.

Trait Implementations

impl<T: Clone> Clone for CloudRedisClusterClient<T>

fn clone(&self) -> CloudRedisClusterClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CloudRedisClusterClient<T>

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

Formats the value using the given formatter.