public sealed class Cluster : IMessage<Cluster>, IEquatable<Cluster>, IDeepCloneable<Cluster>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class Cluster.
A cluster instance.
Namespace
Google.Cloud.Redis.Cluster.V1Assembly
Google.Cloud.Redis.Cluster.V1.dll
Constructors
Cluster()
public Cluster()
Cluster(Cluster)
public Cluster(Cluster other)
Parameter | |
---|---|
Name | Description |
other |
Cluster |
Properties
AuthorizationMode
public AuthorizationMode AuthorizationMode { get; set; }
Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
Property Value | |
---|---|
Type | Description |
AuthorizationMode |
AutomatedBackupConfig
public AutomatedBackupConfig AutomatedBackupConfig { get; set; }
Optional. The automated backup config for the cluster.
Property Value | |
---|---|
Type | Description |
AutomatedBackupConfig |
BackupCollection
public string BackupCollection { get; set; }
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
Property Value | |
---|---|
Type | Description |
string |
BackupCollectionAsBackupCollectionName
public BackupCollectionName BackupCollectionAsBackupCollectionName { get; set; }
BackupCollectionName-typed view over the BackupCollection resource name property.
Property Value | |
---|---|
Type | Description |
BackupCollectionName |
ClusterEndpoints
public RepeatedField<ClusterEndpoint> ClusterEndpoints { get; }
Optional. A list of cluster enpoints.
Property Value | |
---|---|
Type | Description |
RepeatedFieldClusterEndpoint |
ClusterName
public ClusterName ClusterName { get; set; }
ClusterName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
ClusterName |
CreateTime
public Timestamp CreateTime { get; set; }
Output only. The timestamp associated with the cluster creation request.
Property Value | |
---|---|
Type | Description |
Timestamp |
CrossClusterReplicationConfig
public CrossClusterReplicationConfig CrossClusterReplicationConfig { get; set; }
Optional. Cross cluster replication config.
Property Value | |
---|---|
Type | Description |
CrossClusterReplicationConfig |
DeletionProtectionEnabled
public bool DeletionProtectionEnabled { get; set; }
Optional. The delete operation will fail when the value is set to true.
Property Value | |
---|---|
Type | Description |
bool |
DiscoveryEndpoints
public RepeatedField<DiscoveryEndpoint> DiscoveryEndpoints { get; }
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
Property Value | |
---|---|
Type | Description |
RepeatedFieldDiscoveryEndpoint |
EncryptionInfo
public EncryptionInfo EncryptionInfo { get; set; }
Output only. Encryption information of the data at rest of the cluster.
Property Value | |
---|---|
Type | Description |
EncryptionInfo |
GcsSource
public Cluster.Types.GcsBackupSource GcsSource { get; set; }
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
Property Value | |
---|---|
Type | Description |
ClusterTypesGcsBackupSource |
HasBackupCollection
public bool HasBackupCollection { get; }
Gets whether the "backup_collection" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasDeletionProtectionEnabled
public bool HasDeletionProtectionEnabled { get; }
Gets whether the "deletion_protection_enabled" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasKmsKey
public bool HasKmsKey { get; }
Gets whether the "kms_key" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasPreciseSizeGb
public bool HasPreciseSizeGb { get; }
Gets whether the "precise_size_gb" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasReplicaCount
public bool HasReplicaCount { get; }
Gets whether the "replica_count" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasShardCount
public bool HasShardCount { get; }
Gets whether the "shard_count" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasSizeGb
public bool HasSizeGb { get; }
Gets whether the "size_gb" field is set
Property Value | |
---|---|
Type | Description |
bool |
ImportSourcesCase
public Cluster.ImportSourcesOneofCase ImportSourcesCase { get; }
Property Value | |
---|---|
Type | Description |
ClusterImportSourcesOneofCase |
KmsKey
public string KmsKey { get; set; }
Optional. The KMS key used to encrypt the at-rest data of the cluster.
Property Value | |
---|---|
Type | Description |
string |
KmsKeyAsCryptoKeyName
public CryptoKeyName KmsKeyAsCryptoKeyName { get; set; }
CryptoKeyName-typed view over the KmsKey resource name property.
Property Value | |
---|---|
Type | Description |
CryptoKeyName |
MaintenancePolicy
public ClusterMaintenancePolicy MaintenancePolicy { get; set; }
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
Property Value | |
---|---|
Type | Description |
ClusterMaintenancePolicy |
MaintenanceSchedule
public ClusterMaintenanceSchedule MaintenanceSchedule { get; set; }
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
Property Value | |
---|---|
Type | Description |
ClusterMaintenanceSchedule |
ManagedBackupSource
public Cluster.Types.ManagedBackupSource ManagedBackupSource { get; set; }
Optional. Backups generated and managed by memorystore service.
Property Value | |
---|---|
Type | Description |
ClusterTypesManagedBackupSource |
Name
public string Name { get; set; }
Required. Identifier. Unique name of the resource in this scope including
project and location using the form:
projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
Property Value | |
---|---|
Type | Description |
string |
NodeType
public NodeType NodeType { get; set; }
Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
Property Value | |
---|---|
Type | Description |
NodeType |
PersistenceConfig
public ClusterPersistenceConfig PersistenceConfig { get; set; }
Optional. Persistence config (RDB, AOF) for the cluster.
Property Value | |
---|---|
Type | Description |
ClusterPersistenceConfig |
PreciseSizeGb
public double PreciseSizeGb { get; set; }
Output only. Precise value of redis memory size in GB for the entire cluster.
Property Value | |
---|---|
Type | Description |
double |
PscConfigs
public RepeatedField<PscConfig> PscConfigs { get; }
Optional. 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.
Property Value | |
---|---|
Type | Description |
RepeatedFieldPscConfig |
PscConnections
public RepeatedField<PscConnection> PscConnections { get; }
Output only. The list of PSC connections that are auto-created through service connectivity automation.
Property Value | |
---|---|
Type | Description |
RepeatedFieldPscConnection |
PscServiceAttachments
public RepeatedField<PscServiceAttachment> PscServiceAttachments { get; }
Output only. Service attachment details to configure Psc connections
Property Value | |
---|---|
Type | Description |
RepeatedFieldPscServiceAttachment |
RedisConfigs
public MapField<string, string> RedisConfigs { get; }
Optional. Key/Value pairs of customer overrides for mutable Redis Configs
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
ReplicaCount
public int ReplicaCount { get; set; }
Optional. The number of replica nodes per shard.
Property Value | |
---|---|
Type | Description |
int |
ShardCount
public int ShardCount { get; set; }
Optional. Number of shards for the Redis cluster.
Property Value | |
---|---|
Type | Description |
int |
SizeGb
public int SizeGb { get; set; }
Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
Property Value | |
---|---|
Type | Description |
int |
State
public Cluster.Types.State State { get; set; }
Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
Property Value | |
---|---|
Type | Description |
ClusterTypesState |
StateInfo
public Cluster.Types.StateInfo StateInfo { get; set; }
Output only. Additional information about the current state of the cluster.
Property Value | |
---|---|
Type | Description |
ClusterTypesStateInfo |
TransitEncryptionMode
public TransitEncryptionMode TransitEncryptionMode { get; set; }
Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
Property Value | |
---|---|
Type | Description |
TransitEncryptionMode |
Uid
public string Uid { get; set; }
Output only. System assigned, unique identifier for the cluster.
Property Value | |
---|---|
Type | Description |
string |
ZoneDistributionConfig
public ZoneDistributionConfig ZoneDistributionConfig { get; set; }
Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
Property Value | |
---|---|
Type | Description |
ZoneDistributionConfig |