Cluster class

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
• GeneratedMessage
• Cluster

Constructors

Cluster({String? name, String? displayName, String? uid, Timestamp? createTime, Timestamp? updateTime, Timestamp? deleteTime, Map<String, String>? labels, Cluster_State? state, DatabaseVersion? databaseVersion, String? network, String? etag, Map<String, String>? annotations, bool? reconciling, BackupSource? backupSource, MigrationSource? migrationSource, AutomatedBackupPolicy? automatedBackupPolicy, SslConfig? sslConfig, EncryptionConfig? encryptionConfig, EncryptionInfo? encryptionInfo, Cluster_SecondaryConfig? secondaryConfig, Cluster_PrimaryConfig? primaryConfig, Cluster_ClusterType? clusterType})

factory

Cluster.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Cluster.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

annotations → Map<String, String>

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

no setter

automatedBackupPolicy ↔ AutomatedBackupPolicy

The automated backup policy for this cluster.

getter/setter pair

backupSource ↔ BackupSource

Output only. Cluster created from backup.

getter/setter pair

clusterType ↔ Cluster_ClusterType

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

getter/setter pair

createTime ↔ Timestamp

Output only. Create time stamp

getter/setter pair

databaseVersion ↔ DatabaseVersion

Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

getter/setter pair

deleteTime ↔ Timestamp

Output only. Delete time stamp

getter/setter pair

displayName ↔ String

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

getter/setter pair

encryptionConfig ↔ EncryptionConfig

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.

getter/setter pair

encryptionInfo ↔ EncryptionInfo

Output only. The encryption information for the cluster.

getter/setter pair

etag ↔ String

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

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

labels → Map<String, String>

Labels as key value pairs

no setter

migrationSource ↔ MigrationSource

Output only. Cluster created via DMS migration.

getter/setter pair

name ↔ String

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

getter/setter pair

network ↔ String

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_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.

getter/setter pair

primaryConfig ↔ Cluster_PrimaryConfig

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

getter/setter pair

reconciling ↔ bool

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.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryConfig ↔ Cluster_SecondaryConfig

Cross Region replication config specific to SECONDARY cluster.

getter/setter pair

sslConfig ↔ SslConfig

SSL configuration for this AlloyDB Cluster.

getter/setter pair

state ↔ Cluster_State

Output only. The current serving state of the cluster.

getter/setter pair

uid ↔ String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

updateTime ↔ Timestamp

Output only. Update time stamp

getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearAutomatedBackupPolicy() → void

clearBackupSource() → void

clearClusterType() → void

clearCreateTime() → void

clearDatabaseVersion() → void

clearDeleteTime() → void

clearDisplayName() → void

clearEncryptionConfig() → void

clearEncryptionInfo() → void

clearEtag() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearMigrationSource() → void

clearName() → void

clearNetwork() → void

clearPrimaryConfig() → void

clearReconciling() → void

clearSecondaryConfig() → void

clearSource() → void

clearSslConfig() → void

clearState() → void

clearUid() → void

clearUpdateTime() → void

clone() → Cluster

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Cluster)) → Cluster

Apply updates to a copy of this message.

override

createEmptyInstance() → Cluster

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureAutomatedBackupPolicy() → AutomatedBackupPolicy

ensureBackupSource() → BackupSource

ensureCreateTime() → Timestamp

ensureDeleteTime() → Timestamp

ensureEncryptionConfig() → EncryptionConfig

ensureEncryptionInfo() → EncryptionInfo

ensureMigrationSource() → MigrationSource

ensurePrimaryConfig() → Cluster_PrimaryConfig

ensureSecondaryConfig() → Cluster_SecondaryConfig

ensureSslConfig() → SslConfig

ensureUpdateTime() → Timestamp

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasAutomatedBackupPolicy() → bool

hasBackupSource() → bool

hasClusterType() → bool

hasCreateTime() → bool

hasDatabaseVersion() → bool

hasDeleteTime() → bool

hasDisplayName() → bool

hasEncryptionConfig() → bool

hasEncryptionInfo() → bool

hasEtag() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasMigrationSource() → bool

hasName() → bool

hasNetwork() → bool

hasPrimaryConfig() → bool

hasReconciling() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasSecondaryConfig() → bool

hasSslConfig() → bool

hasState() → bool

hasUid() → bool

hasUpdateTime() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

whichSource() → Cluster_Source

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → Cluster

createRepeated() → PbList<Cluster>

getDefault() → Cluster