GetInstanceResult class

Result data returned by getInstance.

Constructors

GetInstanceResult({required AutoscalingConfigResponse autoscalingConfig, required String config, required String createTime, required String displayName, required List<String> endpointUris, required FreeInstanceMetadataResponse freeInstanceMetadata, required String instanceType, required Map<String, String> labels, required String name, required int nodeCount, required int processingUnits, required String state, required String updateTime})
Creates a new GetInstanceResult. autoscalingConfig Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. config The name of the instance's configuration. Values are of the form projects//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs. createTime The time at which the instance was created. displayName The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. endpointUris Deprecated. This field is not populated. freeInstanceMetadata Free instance metadata. Only populated for free instances. instanceType The InstanceType of the current instance. labels Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release. name A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects//instances/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length. nodeCount The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units. processingUnits The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units. state The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY. updateTime The time at which the instance was most recently updated.
const
GetInstanceResult.fromMap(Map<String, dynamic> map)
factory

Properties

autoscalingConfig → AutoscalingConfigResponse
Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
final
config → String
The name of the instance's configuration. Values are of the form projects//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs.
final
createTime → String
The time at which the instance was created.
final
displayName → String
The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
final
endpointUris → List<String>
Deprecated. This field is not populated.
final
freeInstanceMetadata → FreeInstanceMetadataResponse
Free instance metadata. Only populated for free instances.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceType → String
The InstanceType of the current instance.
final
labels → Map<String, String>
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.
final
name → String
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects//instances/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.
final
nodeCount → int
The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units.
final
processingUnits → int
The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → String
The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.
final
updateTime → String
The time at which the instance was most recently updated.
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