Instance class

A Memorystore for Memcached instance

Inheritance

• Object
• GeneratedMessage
• Instance

Constructors

Instance({String? name, String? displayName, Map<String, String>? labels, String? authorizedNetwork, Iterable<String>? zones, int? nodeCount, Instance_NodeConfig? nodeConfig, MemcacheVersion? memcacheVersion, MemcacheParameters? parameters, Iterable<Instance_Node>? memcacheNodes, Timestamp? createTime, Timestamp? updateTime, Instance_State? state, String? memcacheFullVersion, Iterable<Instance_InstanceMessage>? instanceMessages, String? discoveryEndpoint, MaintenancePolicy? maintenancePolicy, MaintenanceSchedule? maintenanceSchedule})

factory

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

factory

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

factory

Properties

authorizedNetwork ↔ String

The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

getter/setter pair

createTime ↔ Timestamp

Output only. The time the instance was created.

getter/setter pair

discoveryEndpoint ↔ String

Output only. Endpoint for the Discovery API.

getter/setter pair

displayName ↔ String

User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.

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

instanceMessages → List<Instance_InstanceMessage>

List of messages that describe the current state of the Memcached instance.

no setter

isFrozen → bool

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

no setter, inherited

labels → Map<String, String>

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

no setter

maintenancePolicy ↔ MaintenancePolicy

The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.

getter/setter pair

maintenanceSchedule ↔ MaintenanceSchedule

Output only. Published maintenance schedule.

getter/setter pair

memcacheFullVersion ↔ String

Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".

getter/setter pair

memcacheNodes → List<Instance_Node>

Output only. List of Memcached nodes. Refer to google.cloud.memcache.v1.Instance.Node message for more details.

no setter

memcacheVersion ↔ MemcacheVersion

The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.

getter/setter pair

name ↔ String

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id}

getter/setter pair

nodeConfig ↔ Instance_NodeConfig

Required. Configuration for Memcached nodes.

getter/setter pair

nodeCount ↔ int

Required. Number of nodes in the Memcached instance.

getter/setter pair

parameters ↔ MemcacheParameters

User defined parameters to apply to the memcached process on each node.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Instance_State

Output only. The state of this Memcached instance.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

updateTime ↔ Timestamp

Output only. The time the instance was updated.

getter/setter pair

zones → List<String>

Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

no setter

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

clearAuthorizedNetwork() → void

clearCreateTime() → void

clearDiscoveryEndpoint() → void

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

clearMaintenancePolicy() → void

clearMaintenanceSchedule() → void

clearMemcacheFullVersion() → void

clearMemcacheVersion() → void

clearName() → void

clearNodeConfig() → void

clearNodeCount() → void

clearParameters() → void

clearState() → void

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

ensureMaintenancePolicy() → MaintenancePolicy

ensureMaintenanceSchedule() → MaintenanceSchedule

ensureNodeConfig() → Instance_NodeConfig

ensureParameters() → MemcacheParameters

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

hasAuthorizedNetwork() → bool

hasCreateTime() → bool

hasDiscoveryEndpoint() → bool

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

hasMaintenancePolicy() → bool

hasMaintenanceSchedule() → bool

hasMemcacheFullVersion() → bool

hasMemcacheVersion() → bool

hasName() → bool

hasNodeConfig() → bool

hasNodeCount() → bool

hasParameters() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

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

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