Package Classes (0.1.8)

Summary of entries of Classes for google-cloud-redis-cluster.

Classes

CloudRedisClusterAsyncClient

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

CloudRedisClusterClient

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

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AuthorizationMode

Available authorization mode of a Redis cluster.

CertificateAuthority

Redis cluster certificate authority

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ManagedCertificateAuthority

CertChain

Cluster

A cluster instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RedisConfigsEntry

The abstract base class for a message.

State

Represents the different states of a Redis cluster.

StateInfo

Represents additional information about the state of the cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateInfo

Represents information about an updating cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ClusterPersistenceConfig

Configuration of the persistence functionality.

AOFConfig

Configuration of the AOF based persistence.

AppendFsync

Available fsync modes.

PersistenceMode

Available persistence modes.

RDBConfig

Configuration of the RDB based persistence.

SnapshotPeriod

Available snapshot periods.

CreateClusterRequest

Request for CreateCluster][CloudRedis.CreateCluster].

DeleteClusterRequest

Request for DeleteCluster][CloudRedis.DeleteCluster].

DiscoveryEndpoint

Endpoints on each network, for Redis clients to connect to the cluster.

GetClusterCertificateAuthorityRequest

Request for GetClusterCertificateAuthorityRequest][CloudRedis.GetClusterCertificateAuthorityRequest].

GetClusterRequest

Request for GetCluster][CloudRedis.GetCluster].

ListClustersRequest

Request for ListClusters][CloudRedis.ListClusters].

ListClustersResponse

Response for ListClusters][CloudRedis.ListClusters].

NodeType

NodeType of a redis cluster node,

OperationMetadata

Pre-defined metadata fields.

PscConfig

PscConnection

Details of consumer resources in a PSC connection.

TransitEncryptionMode

Available mode of in-transit encryption.

UpdateClusterRequest

Request for UpdateCluster][CloudRedis.UpdateCluster].

ZoneDistributionConfig

Zone distribution config for allocation of cluster resources.

ZoneDistributionMode

Defines various modes of zone distribution. Currently supports two modes, can be expanded in future to support more types of distribution modes. design doc: go/same-zone-cluster

CloudRedisClusterAsyncClient

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

CloudRedisClusterClient

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

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Modules

pagers

API documentation for redis_cluster_v1.services.cloud_redis_cluster.pagers module.

pagers

API documentation for redis_cluster_v1beta1.services.cloud_redis_cluster.pagers module.