Show / Hide Table of Contents

Class Cluster

A cluster instance.

Inheritance
object
Cluster
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudRedis.v1beta1.Data
Assembly: Google.Apis.CloudRedis.v1beta1.dll
Syntax
public class Cluster : IDirectResponseSchema

Properties

AsyncClusterEndpointsDeletionEnabled

Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.

Declaration
[JsonProperty("asyncClusterEndpointsDeletionEnabled")]
public virtual bool? AsyncClusterEndpointsDeletionEnabled { get; set; }
Property Value
Type Description
bool?

AuthorizationMode

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

Declaration
[JsonProperty("authorizationMode")]
public virtual string AuthorizationMode { get; set; }
Property Value
Type Description
string

AutomatedBackupConfig

Optional. The automated backup config for the cluster.

Declaration
[JsonProperty("automatedBackupConfig")]
public virtual AutomatedBackupConfig AutomatedBackupConfig { get; set; }
Property Value
Type Description
AutomatedBackupConfig

BackupCollection

Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

Declaration
[JsonProperty("backupCollection")]
public virtual string BackupCollection { get; set; }
Property Value
Type Description
string

ClusterEndpoints

Optional. A list of cluster endpoints.

Declaration
[JsonProperty("clusterEndpoints")]
public virtual IList<ClusterEndpoint> ClusterEndpoints { get; set; }
Property Value
Type Description
IList<ClusterEndpoint>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The timestamp associated with the cluster creation request.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CrossClusterReplicationConfig

Optional. Cross cluster replication config.

Declaration
[JsonProperty("crossClusterReplicationConfig")]
public virtual CrossClusterReplicationConfig CrossClusterReplicationConfig { get; set; }
Property Value
Type Description
CrossClusterReplicationConfig

DeletionProtectionEnabled

Optional. The delete operation will fail when the value is set to true.

Declaration
[JsonProperty("deletionProtectionEnabled")]
public virtual bool? DeletionProtectionEnabled { get; set; }
Property Value
Type Description
bool?

DiscoveryEndpoints

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

Declaration
[JsonProperty("discoveryEndpoints")]
public virtual IList<DiscoveryEndpoint> DiscoveryEndpoints { get; set; }
Property Value
Type Description
IList<DiscoveryEndpoint>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionInfo

Output only. Encryption information of the data at rest of the cluster.

Declaration
[JsonProperty("encryptionInfo")]
public virtual EncryptionInfo EncryptionInfo { get; set; }
Property Value
Type Description
EncryptionInfo

GcsSource

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.

Declaration
[JsonProperty("gcsSource")]
public virtual GcsBackupSource GcsSource { get; set; }
Property Value
Type Description
GcsBackupSource

KmsKey

Optional. The KMS key used to encrypt the at-rest data of the cluster.

Declaration
[JsonProperty("kmsKey")]
public virtual string KmsKey { get; set; }
Property Value
Type Description
string

MaintenancePolicy

Optional. ClusterMaintenancePolicy determines when to allow or deny updates.

Declaration
[JsonProperty("maintenancePolicy")]
public virtual ClusterMaintenancePolicy MaintenancePolicy { get; set; }
Property Value
Type Description
ClusterMaintenancePolicy

MaintenanceSchedule

Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.

Declaration
[JsonProperty("maintenanceSchedule")]
public virtual ClusterMaintenanceSchedule MaintenanceSchedule { get; set; }
Property Value
Type Description
ClusterMaintenanceSchedule

ManagedBackupSource

Optional. Backups generated and managed by memorystore service.

Declaration
[JsonProperty("managedBackupSource")]
public virtual ManagedBackupSource ManagedBackupSource { get; set; }
Property Value
Type Description
ManagedBackupSource

Name

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}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NodeType

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

Declaration
[JsonProperty("nodeType")]
public virtual string NodeType { get; set; }
Property Value
Type Description
string

OndemandMaintenance

Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.

Declaration
[JsonProperty("ondemandMaintenance")]
public virtual bool? OndemandMaintenance { get; set; }
Property Value
Type Description
bool?

PersistenceConfig

Optional. Persistence config (RDB, AOF) for the cluster.

Declaration
[JsonProperty("persistenceConfig")]
public virtual ClusterPersistenceConfig PersistenceConfig { get; set; }
Property Value
Type Description
ClusterPersistenceConfig

PreciseSizeGb

Output only. Precise value of redis memory size in GB for the entire cluster.

Declaration
[JsonProperty("preciseSizeGb")]
public virtual double? PreciseSizeGb { get; set; }
Property Value
Type Description
double?

PscConfigs

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.

Declaration
[JsonProperty("pscConfigs")]
public virtual IList<PscConfig> PscConfigs { get; set; }
Property Value
Type Description
IList<PscConfig>

PscConnections

Output only. The list of PSC connections that are auto-created through service connectivity automation.

Declaration
[JsonProperty("pscConnections")]
public virtual IList<PscConnection> PscConnections { get; set; }
Property Value
Type Description
IList<PscConnection>

PscServiceAttachments

Output only. Service attachment details to configure Psc connections

Declaration
[JsonProperty("pscServiceAttachments")]
public virtual IList<PscServiceAttachment> PscServiceAttachments { get; set; }
Property Value
Type Description
IList<PscServiceAttachment>

RedisConfigs

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

Declaration
[JsonProperty("redisConfigs")]
public virtual IDictionary<string, string> RedisConfigs { get; set; }
Property Value
Type Description
IDictionary<string, string>

ReplicaCount

Optional. The number of replica nodes per shard.

Declaration
[JsonProperty("replicaCount")]
public virtual int? ReplicaCount { get; set; }
Property Value
Type Description
int?

ShardCount

Optional. Number of shards for the Redis cluster.

Declaration
[JsonProperty("shardCount")]
public virtual int? ShardCount { get; set; }
Property Value
Type Description
int?

SizeGb

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

Declaration
[JsonProperty("sizeGb")]
public virtual int? SizeGb { get; set; }
Property Value
Type Description
int?

State

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StateInfo

Output only. Additional information about the current state of the cluster.

Declaration
[JsonProperty("stateInfo")]
public virtual StateInfo StateInfo { get; set; }
Property Value
Type Description
StateInfo

TransitEncryptionMode

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

Declaration
[JsonProperty("transitEncryptionMode")]
public virtual string TransitEncryptionMode { get; set; }
Property Value
Type Description
string

Uid

Output only. System assigned, unique identifier for the cluster.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

ZoneDistributionConfig

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

Declaration
[JsonProperty("zoneDistributionConfig")]
public virtual ZoneDistributionConfig ZoneDistributionConfig { get; set; }
Property Value
Type Description
ZoneDistributionConfig

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX