Instance class

A Memorystore for Redis instance.

Inheritance

• Object
• GeneratedMessage
• Instance

Constructors

Instance({String? name, String? displayName, Map<String, String>? labels, String? locationId, String? alternativeLocationId, String? redisVersion, String? reservedIpRange, String? host, int? port, String? currentLocationId, Timestamp? createTime, Instance_State? state, String? statusMessage, Map<String, String>? redisConfigs, Instance_Tier? tier, int? memorySizeGb, String? authorizedNetwork, String? persistenceIamIdentity, Instance_ConnectMode? connectMode, bool? authEnabled, Iterable<TlsCertificate>? serverCaCerts, Instance_TransitEncryptionMode? transitEncryptionMode, MaintenancePolicy? maintenancePolicy, MaintenanceSchedule? maintenanceSchedule, String? secondaryIpRange, int? replicaCount, Iterable<NodeInfo>? nodes, String? readEndpoint, int? readEndpointPort, Instance_ReadReplicasMode? readReplicasMode, String? customerManagedKey, PersistenceConfig? persistenceConfig, Iterable<Instance_SuspensionReason>? suspensionReasons, String? maintenanceVersion, Iterable<String>? availableMaintenanceVersions})

factory

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

factory

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

factory

Properties

alternativeLocationId ↔ String

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in location_id. Additional nodes beyond the first 2 will be placed in zones selected by the service.

getter/setter pair

authEnabled ↔ bool

Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

getter/setter pair

authorizedNetwork ↔ String

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

availableMaintenanceVersions → List<String>

Optional. The available maintenance versions that an instance could update to.

no setter

connectMode ↔ Instance_ConnectMode

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

getter/setter pair

createTime ↔ Timestamp

Output only. The time the instance was created.

getter/setter pair

currentLocationId ↔ String

Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as location_id. In standard tier, this can be the zone of any node in the instance.

getter/setter pair

customerManagedKey ↔ String

Optional. The KMS key reference that the customer provides when trying to create the instance.

getter/setter pair

displayName ↔ String

An arbitrary and optional user-provided name for the instance.

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

host ↔ String

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

getter/setter pair

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>

Resource labels to represent user provided metadata

no setter

locationId ↔ String

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

getter/setter pair

maintenancePolicy ↔ MaintenancePolicy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

getter/setter pair

maintenanceSchedule ↔ MaintenanceSchedule

Output only. Date and time of upcoming maintenance events which have been scheduled.

getter/setter pair

maintenanceVersion ↔ String

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

getter/setter pair

memorySizeGb ↔ int

Required. Redis memory size in GiB.

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

nodes → List<NodeInfo>

Output only. Info per node.

no setter

persistenceConfig ↔ PersistenceConfig

Optional. Persistence configuration parameters

getter/setter pair

persistenceIamIdentity ↔ String

Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.

getter/setter pair

port ↔ int

Output only. The port number of the exposed Redis endpoint.

getter/setter pair

readEndpoint ↔ String

Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.

getter/setter pair

readEndpointPort ↔ int

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

getter/setter pair

readReplicasMode ↔ Instance_ReadReplicasMode

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

getter/setter pair

redisConfigs → Map<String, String>

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are:

no setter

redisVersion ↔ String

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are:

getter/setter pair

replicaCount ↔ int

Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is 1-5 and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

getter/setter pair

reservedIpRange ↔ String

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryIpRange ↔ String

Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".

getter/setter pair

serverCaCerts → List<TlsCertificate>

Output only. List of server CA certificates for the instance.

no setter

state ↔ Instance_State

Output only. The current state of this instance.

getter/setter pair

statusMessage ↔ String

Output only. Additional information about the current status of this instance, if available.

getter/setter pair

suspensionReasons → List<Instance_SuspensionReason>

Optional. reasons that causes instance in "SUSPENDED" state.

no setter

tier ↔ Instance_Tier

Required. The service tier of the instance.

getter/setter pair

transitEncryptionMode ↔ Instance_TransitEncryptionMode

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

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

clearAlternativeLocationId() → void

clearAuthEnabled() → void

clearAuthorizedNetwork() → void

clearConnectMode() → void

clearCreateTime() → void

clearCurrentLocationId() → void

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

clearHost() → void

clearLocationId() → void

clearMaintenancePolicy() → void

clearMaintenanceSchedule() → void

clearMaintenanceVersion() → void

clearMemorySizeGb() → void

clearName() → void

clearPersistenceConfig() → void

clearPersistenceIamIdentity() → void

clearPort() → void

clearReadEndpoint() → void

clearReadEndpointPort() → void

clearReadReplicasMode() → void

clearRedisVersion() → void

clearReplicaCount() → void

clearReservedIpRange() → void

clearSecondaryIpRange() → void

clearState() → void

clearStatusMessage() → void

clearTier() → void

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

ensurePersistenceConfig() → PersistenceConfig

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

hasAlternativeLocationId() → bool

hasAuthEnabled() → bool

hasAuthorizedNetwork() → bool

hasConnectMode() → bool

hasCreateTime() → bool

hasCurrentLocationId() → bool

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

hasHost() → bool

hasLocationId() → bool

hasMaintenancePolicy() → bool

hasMaintenanceSchedule() → bool

hasMaintenanceVersion() → bool

hasMemorySizeGb() → bool

hasName() → bool

hasPersistenceConfig() → bool

hasPersistenceIamIdentity() → bool

hasPort() → bool

hasReadEndpoint() → bool

hasReadEndpointPort() → bool

hasReadReplicasMode() → bool

hasRedisVersion() → bool

hasReplicaCount() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasReservedIpRange() → bool

hasSecondaryIpRange() → bool

hasState() → bool

hasStatusMessage() → bool

hasTier() → bool

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