string

Required. The name of the instance's configuration. Values are of the formprojects/<project>/instanceConfigs/<configuration>. See alsoInstanceConfig andinstanceConfigs.list.

string

Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

integer

The number of nodes allocated to this instance. At most, one of eithernodeCount orprocessingUnits should be present in the message.

Users can set thenodeCount field to specify the target number of nodes allocated to the instance.

If autoscaling is enabled,nodeCount is treated as anOUTPUT_ONLY field and reflects the current number of nodes allocated to the instance.

This might be zero in API responses for instances that are not yet in theREADY state.

If the instance has varying node count across replicas (achieved by settingasymmetricAutoscalingOptions in the autoscaling configuration), thenodeCount set here is the maximum node count across all replicas.

For more information, seeCompute capacity, nodes, and processing units.

integer

The number of processing units allocated to this instance. At most, one of eitherprocessingUnits ornodeCount should be present in the message.

Users can set theprocessingUnits field to specify the target number of processing units allocated to the instance.

If autoscaling is enabled,processingUnits is treated as anOUTPUT_ONLY field and reflects the current number of processing units allocated to the instance.

This might be zero in API responses for instances that are not yet in theREADY state.

If the instance has varying processing units per replica (achieved by settingasymmetricAutoscalingOptions in the autoscaling configuration), theprocessingUnits set here is the maximum processing units across all replicas.

For more information, seeCompute capacity, nodes and processing units.

object (ReplicaComputeCapacity)

Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.

object (AutoscalingConfig)

Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.

enum (State)

Output only. The current instance state. Forinstances.create, the state must be either omitted or set toCREATING. Forinstances.patch, the state must be either omitted or set toREADY.

map (key: string, value: 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][a-z0-9_-]{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.

Seehttps://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.

enum (InstanceType)

TheInstanceType of the current instance.

string

Deprecated. This field is not populated.

string (Timestamp format)

Output only. The time at which the instance was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string (Timestamp format)

Output only. The time at which the instance was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

object (FreeInstanceMetadata)

Free instance metadata. Only populated for free instances.

enum (Edition)

Optional. TheEdition of the current instance.

enum (DefaultBackupScheduleType)

Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance.

Note that theAUTOMATIC value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances.

In theinstances.get orinstances.list response, if the value ofdefaultBackupScheduleType isn't set, or set toNONE, Spanner doesn't create a default backup schedule for new databases in the instance.

string (FieldMask format)

Required. A mask specifying which fields inInstance should be updated. The field mask must always be specified; this prevents any future fields inInstance from being erased accidentally by clients that do not know about them.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".