Instance class

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Inheritance

• Object
• GeneratedMessage
• Instance

Constructors

Instance({String? name, String? displayName, String? uid, Timestamp? createTime, Timestamp? updateTime, Timestamp? deleteTime, Map<String, String>? labels, Instance_State? state, Instance_InstanceType? instanceType, Instance_MachineConfig? machineConfig, Instance_AvailabilityType? availabilityType, String? gceZone, Map<String, String>? databaseFlags, Instance_ReadPoolConfig? readPoolConfig, String? ipAddress, bool? reconciling, String? etag, Map<String, String>? annotations, Instance_Node? writableNode, Iterable<Instance_Node>? nodes, Instance_QueryInsightsInstanceConfig? queryInsightsConfig})

factory

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

factory

Instance.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

availabilityType ↔ Instance_AvailabilityType

Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

getter/setter pair

createTime ↔ Timestamp

Output only. Create time stamp

getter/setter pair

databaseFlags → Map<String, String>

Database flags. Set at instance level.

no setter

deleteTime ↔ Timestamp

Output only. Delete time stamp

getter/setter pair

displayName ↔ String

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

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

gceZone ↔ String

The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

getter/setter pair

hashCode → int

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

no setter, inherited

info_ → BuilderInfo

no setter, override

instanceType ↔ Instance_InstanceType

Required. The type of the instance. Specified at creation time.

getter/setter pair

ipAddress ↔ String

Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

getter/setter pair

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

machineConfig ↔ Instance_MachineConfig

Configurations for the machines that host the underlying database engine.

getter/setter pair

name ↔ String

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

getter/setter pair

nodes → List<Instance_Node>

Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

no setter

queryInsightsConfig ↔ Instance_QueryInsightsInstanceConfig

Configuration for query insights.

getter/setter pair

readPoolConfig ↔ Instance_ReadPoolConfig

Read pool specific config.

getter/setter pair

reconciling ↔ bool

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance 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

state ↔ Instance_State

Output only. The current serving state of the instance.

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

writableNode ↔ Instance_Node

Output only. This is set for the read-write VM of the PRIMARY instance only.

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

clearAvailabilityType() → void

clearCreateTime() → void

clearDeleteTime() → void

clearDisplayName() → 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

clearGceZone() → void

clearInstanceType() → void

clearIpAddress() → void

clearMachineConfig() → void

clearName() → void

clearQueryInsightsConfig() → void

clearReadPoolConfig() → void

clearReconciling() → void

clearState() → void

clearUid() → void

clearUpdateTime() → void

clearWritableNode() → void

clone() → Instance

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

override

copyWith(void updates(Instance)) → Instance

Apply updates to a copy of this message.

override

createEmptyInstance() → Instance

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

ensureCreateTime() → Timestamp

ensureDeleteTime() → Timestamp

ensureMachineConfig() → Instance_MachineConfig

ensureQueryInsightsConfig() → Instance_QueryInsightsInstanceConfig

ensureReadPoolConfig() → Instance_ReadPoolConfig

ensureUpdateTime() → Timestamp

ensureWritableNode() → Instance_Node

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

hasAvailabilityType() → bool

hasCreateTime() → bool

hasDeleteTime() → bool

hasDisplayName() → 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

hasGceZone() → bool

hasInstanceType() → bool

hasIpAddress() → bool

hasMachineConfig() → bool

hasName() → bool

hasQueryInsightsConfig() → bool

hasReadPoolConfig() → bool

hasReconciling() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasState() → bool

hasUid() → bool

hasUpdateTime() → bool

hasWritableNode() → 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

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() → Instance

createRepeated() → PbList<Instance>

getDefault() → Instance