Resource: InstanceConfig
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
JSON representation |
---|
{ "name": string, "displayName": string, "configType": enum ( |
Fields | |
---|---|
name |
A unique identifier for the instance configuration. Values are of the form |
displayName |
The name of this instance configuration as it appears in UIs. |
configType |
Output only. Whether this instance config is a Google or User Managed Configuration. |
replicas[] |
The geographic placement of nodes in this instance configuration and their replication properties. |
optionalReplicas[] |
Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. |
baseConfig |
Base configuration name, e.g. projects/ |
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.).
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. Therefore, 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. |
etag |
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. |
leaderOptions[] |
Allowed values of the "defaultLeader" schema option for databases in instances that use this instance configuration. |
reconciling |
Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. |
state |
Output only. The current instance config state. |
freeInstanceAvailability |
Output only. Describes whether free instances are available to be created in this instance config. |
Type
The type of this configuration.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
GOOGLE_MANAGED |
Google managed configuration. |
USER_MANAGED |
User managed configuration. |
ReplicaInfo
JSON representation |
---|
{
"location": string,
"type": enum ( |
Fields | |
---|---|
location |
The location of the serving resources, e.g. "us-central1". |
type |
The type of replica. |
defaultLeaderLocation |
If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details. |
ReplicaType
Indicates the type of replica. See the replica types documentation for more details.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Not specified. |
READ_WRITE |
sessions.read-write replicas support both reads and writes. These replicas:
|
READ_ONLY |
sessions.read-only replicas only support reads (not writes). sessions.read-only replicas:
|
WITNESS |
Witness replicas don't support reads but do participate in voting to commit writes. Witness replicas:
|
State
Indicates the current state of the instance config.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not specified. |
CREATING |
The instance config is still being created. |
READY |
The instance config is fully created and ready to be used to create instances. |
FreeInstanceAvailability
Describes the availability for free instances to be created in an instance config.
Enums | |
---|---|
FREE_INSTANCE_AVAILABILITY_UNSPECIFIED |
Not specified. |
AVAILABLE |
Indicates that free instances are available to be created in this instance config. |
UNSUPPORTED |
Indicates that free instances are not supported in this instance config. |
DISABLED |
Indicates that free instances are currently not available to be created in this instance config. |
QUOTA_EXCEEDED |
Indicates that additional free instances cannot be created in this instance config because the project has reached its limit of free instances. |
Methods |
|
---|---|
|
Creates an instance config and begins preparing it to be used. |
|
Deletes the instance config. |
|
Gets information about a particular instance configuration. |
|
Lists the supported instance configurations for a given project. |
|
Updates an instance config. |