GetInstanceResult class

Result data returned by getInstance.

Constructors

GetInstanceResult({required String alternativeLocationId, required bool authEnabled, required String authorizedNetwork, required List<String> availableMaintenanceVersions, required String connectMode, required String createTime, required String currentLocationId, required String customerManagedKey, required String displayName, required String host, required Map<String, String> labels, required String location, required MaintenancePolicyResponse maintenancePolicy, required MaintenanceScheduleResponse maintenanceSchedule, required String maintenanceVersion, required int memorySizeGb, required String name, required List<NodeInfoResponse> nodes, required PersistenceConfigResponse persistenceConfig, required String persistenceIamIdentity, required int port, required String readEndpoint, required int readEndpointPort, required String readReplicasMode, required Map<String, String> redisConfigs, required String redisVersion, required int replicaCount, required String reservedIpRange, required bool satisfiesPzs, required String secondaryIpRange, required List<TlsCertificateResponse> serverCaCerts, required String state, required String statusMessage, required List<String> suspensionReasons, required String tier, required String transitEncryptionMode})
Creates a new GetInstanceResult. alternativeLocationId 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. authEnabled 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. authorizedNetwork 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. availableMaintenanceVersions Optional. The available maintenance versions that an instance could update to. connectMode Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. createTime The time the instance was created. currentLocationId 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. customerManagedKey Optional. The KMS key reference that the customer provides when trying to create the instance. displayName An arbitrary and optional user-provided name for the instance. host Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. labels Resource labels to represent user provided metadata location 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. maintenancePolicy Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time. maintenanceSchedule Date and time of upcoming maintenance events which have been scheduled. maintenanceVersion Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". memorySizeGb Redis memory size in GiB. name Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. nodes Info per node. persistenceConfig Optional. Persistence configuration parameters persistenceIamIdentity Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. port The port number of the exposed Redis endpoint. readEndpoint 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'. readEndpointPort The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. readReplicasMode Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. redisConfigs Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries redisVersion Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility replicaCount 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. reservedIpRange 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. satisfiesPzs Optional. Output only. Reserved for future use. Zone Separation compliance state of the instance. Field name and documentation is obfuscated according to go/zs-resource-status. secondaryIpRange 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". serverCaCerts List of server CA certificates for the instance. state The current state of this instance. statusMessage Additional information about the current status of this instance, if available. suspensionReasons Optional. reasons that causes instance in "SUSPENDED" state. tier The service tier of the instance. transitEncryptionMode Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
const
GetInstanceResult.fromMap(Map<String, dynamic> map)
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.
final
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.
final
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.
final
availableMaintenanceVersions → List<String>
Optional. The available maintenance versions that an instance could update to.
final
connectMode → String
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
final
createTime → String
The time the instance was created.
final
currentLocationId → String
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.
final
customerManagedKey → String
Optional. The KMS key reference that the customer provides when trying to create the instance.
final
displayName → String
An arbitrary and optional user-provided name for the instance.
final
hashCode → int
The hash code for this object.
no setterinherited
host → String
Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
final
labels → Map<String, String>
Resource labels to represent user provided metadata
final
location → 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.
final
maintenancePolicy → MaintenancePolicyResponse
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
final
maintenanceSchedule → MaintenanceScheduleResponse
Date and time of upcoming maintenance events which have been scheduled.
final
maintenanceVersion → String
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
final
memorySizeGb → int
Redis memory size in GiB.
final
name → String
Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.
final
nodes → List<NodeInfoResponse>
Info per node.
final
persistenceConfig → PersistenceConfigResponse
Optional. Persistence configuration parameters
final
persistenceIamIdentity → String
Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
final
port → int
The port number of the exposed Redis endpoint.
final
readEndpoint → String
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'.
final
readEndpointPort → int
The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
final
readReplicasMode → String
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
final
redisConfigs → Map<String, String>
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
final
redisVersion → String
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility
final
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.
final
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → bool
Optional. Output only. Reserved for future use. Zone Separation compliance state of the instance. Field name and documentation is obfuscated according to go/zs-resource-status.
final
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".
final
serverCaCerts → List<TlsCertificateResponse>
List of server CA certificates for the instance.
final
state → String
The current state of this instance.
final
statusMessage → String
Additional information about the current status of this instance, if available.
final
suspensionReasons → List<String>
Optional. reasons that causes instance in "SUSPENDED" state.
final
tier → String
The service tier of the instance.
final
transitEncryptionMode → String
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited