AlloyDB v1alpha API - Class Cluster (1.0.0-alpha10)

public sealed class Cluster : IMessage<Cluster>, IEquatable<Cluster>, IDeepCloneable<Cluster>, IBufferMessage, IMessage

Reference documentation and code samples for the AlloyDB v1alpha API class Cluster.

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

Inheritance

object > Cluster

Implements

IMessage Cluster, IEquatable Cluster, IDeepCloneable Cluster, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1Alpha

Assembly

Google.Cloud.AlloyDb.V1Alpha.dll

Constructors

Cluster()

public Cluster()

Cluster(Cluster)

public Cluster(Cluster other)

Parameter
Name	Description
`other`	`Cluster`

Properties

Annotations

public MapField<string, string> Annotations { get; }

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Property Value
Type	Description
`MapFieldstringstring`

AutomatedBackupPolicy

public AutomatedBackupPolicy AutomatedBackupPolicy { get; set; }

The automated backup policy for this cluster.

If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

Property Value
Type	Description
`AutomatedBackupPolicy`

BackupSource

public BackupSource BackupSource { get; set; }

Output only. Cluster created from backup.

Property Value
Type	Description
`BackupSource`

CloudsqlBackupRunSource

public CloudSQLBackupRunSource CloudsqlBackupRunSource { get; set; }

Output only. Cluster created from CloudSQL snapshot.

Property Value
Type	Description
`CloudSQLBackupRunSource`

ClusterName

public ClusterName ClusterName { get; set; }

ClusterName-typed view over the Name resource name property.

Property Value
Type	Description
`ClusterName`

ClusterType

public Cluster.Types.ClusterType ClusterType { get; set; }

Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster

Property Value
Type	Description
`ClusterTypesClusterType`

ContinuousBackupConfig

public ContinuousBackupConfig ContinuousBackupConfig { get; set; }

Optional. Continuous backup configuration for this cluster.

Property Value
Type	Description
`ContinuousBackupConfig`

ContinuousBackupInfo

public ContinuousBackupInfo ContinuousBackupInfo { get; set; }

Output only. Continuous backup properties for this cluster.

Property Value
Type	Description
`ContinuousBackupInfo`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Create time stamp

Property Value
Type	Description
`Timestamp`

DatabaseVersion

public DatabaseVersion DatabaseVersion { get; set; }

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

Property Value
Type	Description
`DatabaseVersion`

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. Delete time stamp

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

User-settable and human-readable display name for the Cluster.

Property Value
Type	Description
`string`

EncryptionConfig

public EncryptionConfig EncryptionConfig { get; set; }

Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

Property Value
Type	Description
`EncryptionConfig`

EncryptionInfo

public EncryptionInfo EncryptionInfo { get; set; }

Output only. The encryption information for the cluster.

Property Value
Type	Description
`EncryptionInfo`

Etag

public string Etag { get; set; }

For Resource freshness validation (https://google.aip.dev/154)

Property Value
Type	Description
`string`

GeminiConfig

public GeminiClusterConfig GeminiConfig { get; set; }

Optional. Configuration parameters related to the Gemini in Databases add-on.

Property Value
Type	Description
`GeminiClusterConfig`

InitialUser

public UserPassword InitialUser { get; set; }

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

Property Value
Type	Description
`UserPassword`

Labels

public MapField<string, string> Labels { get; }

Labels as key value pairs

Property Value
Type	Description
`MapFieldstringstring`

MaintenanceSchedule

public MaintenanceSchedule MaintenanceSchedule { get; set; }

Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

Property Value
Type	Description
`MaintenanceSchedule`

MaintenanceUpdatePolicy

public MaintenanceUpdatePolicy MaintenanceUpdatePolicy { get; set; }

Optional. The maintenance update policy determines when to allow or deny updates.

Property Value
Type	Description
`MaintenanceUpdatePolicy`

MigrationSource

public MigrationSource MigrationSource { get; set; }

Output only. Cluster created via DMS migration.

Property Value
Type	Description
`MigrationSource`

Name

public string Name { get; set; }

Output only. The name of the cluster resource with the format:

projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource:
projects/{project}/locations/{region}

Property Value
Type	Description
`string`

Network

[Obsolete]
public string Network { get; set; }

Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.

Property Value
Type	Description
`string`

NetworkAsNetworkName

[Obsolete]
public NetworkName NetworkAsNetworkName { get; set; }

NetworkName-typed view over the Network resource name property.

Property Value
Type	Description
`NetworkName`

NetworkConfig

public Cluster.Types.NetworkConfig NetworkConfig { get; set; }

Property Value
Type	Description
`ClusterTypesNetworkConfig`

PrimaryConfig

public Cluster.Types.PrimaryConfig PrimaryConfig { get; set; }

Output only. Cross Region replication config specific to PRIMARY cluster.

Property Value
Type	Description
`ClusterTypesPrimaryConfig`

PscConfig

public Cluster.Types.PscConfig PscConfig { get; set; }

Optional. The configuration for Private Service Connect (PSC) for the cluster.

Property Value
Type	Description
`ClusterTypesPscConfig`

Reconciling

public bool Reconciling { get; set; }

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Property Value
Type	Description
`bool`

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }