Class Cluster (0.1.11) 

Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A cluster instance.

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

Attributes
Name Description
name str
Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp associated with the cluster creation request.
state google.cloud.redis_cluster_v1beta1.types.Cluster.State
Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
uid str
Output only. System assigned, unique identifier for the cluster.
replica_count int
Optional. The number of replica nodes per shard. This field is a member of oneof_ _replica_count.
authorization_mode google.cloud.redis_cluster_v1beta1.types.AuthorizationMode
Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
transit_encryption_mode google.cloud.redis_cluster_v1beta1.types.TransitEncryptionMode
Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
size_gb int
Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. This field is a member of oneof_ _size_gb.
shard_count int
Required. Number of shards for the Redis cluster. This field is a member of oneof_ _shard_count.
psc_configs MutableSequence[google.cloud.redis_cluster_v1beta1.types.PscConfig]
Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
discovery_endpoints MutableSequence[google.cloud.redis_cluster_v1beta1.types.DiscoveryEndpoint]
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
psc_connections MutableSequence[google.cloud.redis_cluster_v1beta1.types.PscConnection]
Output only. PSC connections for discovery of the cluster topology and accessing the cluster.
state_info google.cloud.redis_cluster_v1beta1.types.Cluster.StateInfo
Output only. Additional information about the current state of the cluster.
node_type google.cloud.redis_cluster_v1beta1.types.NodeType
Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
persistence_config google.cloud.redis_cluster_v1beta1.types.ClusterPersistenceConfig
Optional. Persistence config (RDB, AOF) for the cluster.
redis_configs MutableMapping[str, str]
Optional. Key/Value pairs of customer overrides for mutable Redis Configs
precise_size_gb float
Output only. Precise value of redis memory size in GB for the entire cluster. This field is a member of oneof_ _precise_size_gb.
zone_distribution_config google.cloud.redis_cluster_v1beta1.types.ZoneDistributionConfig
Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
deletion_protection_enabled bool
Optional. The delete operation will fail when the value is set to true. This field is a member of oneof_ _deletion_protection_enabled.

Classes

RedisConfigsEntry

RedisConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Represents the different states of a Redis cluster.

StateInfo

StateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents additional information about the state of the cluster.

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