Enumeration

State

static

number

Indicates the current state of the instance.

Value

STATE_UNSPECIFIED

Not specified.

CREATING

The instance is still being created. Resources may not be available yet, and operations such as database creation may not work.

READY

The instance is fully created and ready to do work such as creating databases.

Property

State

static

number

Indicates the current state of the instance.

Value

STATE_UNSPECIFIED

Not specified.

CREATING

The instance is still being created. Resources may not be available yet, and operations such as database creation may not work.

READY

The instance is fully created and ready to do work such as creating databases.

Abstract types

CreateInstanceMetadata

static

Metadata type for the operation returned by CreateInstance.

Properties

Parameter

instance

Object

The instance being created.

This object should have the same structure as Instance

startTime

Object

The time at which the CreateInstance request was received.

This object should have the same structure as Timestamp

cancelTime

Object

The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.

This object should have the same structure as Timestamp

endTime

Object

The time at which this operation failed or was completed successfully.

This object should have the same structure as Timestamp

See also

google.spanner.admin.instance.v1.CreateInstanceMetadata definition in proto format

CreateInstanceRequest

static

The request for CreateInstance.

Properties

Parameter

parent

string

Required. The name of the project in which to create the instance. Values are of the form projects/<project>.

instanceId

string

Required. The ID of the instance to create. Valid identifiers are of the form [a-z][-a-z0-9]*[a-z0-9] and must be between 6 and 30 characters in length.

instance

Object

Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.

This object should have the same structure as Instance

See also

google.spanner.admin.instance.v1.CreateInstanceRequest definition in proto format

DeleteInstanceRequest

static

The request for DeleteInstance.

Property

Parameter

name

string

Required. The name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>

See also

google.spanner.admin.instance.v1.DeleteInstanceRequest definition in proto format

GetInstanceConfigRequest

static

The request for GetInstanceConfigRequest.

Property

Parameter

name

string

Required. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.

See also

google.spanner.admin.instance.v1.GetInstanceConfigRequest definition in proto format

GetInstanceRequest

static

The request for GetInstance.

Property

Parameter

name

string

Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

See also

google.spanner.admin.instance.v1.GetInstanceRequest definition in proto format

Instance

static

An isolated set of Cloud Spanner resources on which databases can be hosted.

Properties

Parameter

name

string

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length.

config

string

Required. The name of the instance's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.

displayName

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.

nodeCount

number

Required. The number of nodes allocated to this 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.

state

number

Output only. 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.

The number should be among the values of State

labels

Object with string properties

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][a-z0-9])?.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?.
  • 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.

See also

google.spanner.admin.instance.v1.Instance definition in proto format

InstanceConfig

static

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

Properties

Parameter

name

string

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*

displayName

string

The name of this instance configuration as it appears in UIs.

See also

google.spanner.admin.instance.v1.InstanceConfig definition in proto format

ListInstanceConfigsRequest

static

The request for ListInstanceConfigs.

Properties

Parameter

parent

string

Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.

pageSize

number

Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken

string

If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigsResponse.

See also

google.spanner.admin.instance.v1.ListInstanceConfigsRequest definition in proto format

ListInstanceConfigsResponse

static

The response for ListInstanceConfigs.

Properties

Parameter

instanceConfigs

Array of Object

The list of requested instance configurations.

This object should have the same structure as InstanceConfig

nextPageToken

string

next_page_token can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations.

See also

google.spanner.admin.instance.v1.ListInstanceConfigsResponse definition in proto format

ListInstancesRequest

static

The request for ListInstances.

Properties

Parameter

parent

string

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

pageSize

number

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken

string

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

filter

string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `display_name`
* `labels.key` where key is the name of a label

Some examples of using filters are:

* `name:*` --> The instance has a name.
* `name:Howl` --> The instance's name contains the string "howl".
* `name:HOWL` --> Equivalent to above.
* `NAME:howl` --> Equivalent to above.
* `labels.env:*` --> The instance has the label "env".
* `labels.env:dev` --> The instance has the label "env" and the value of
                     the label contains the string "dev".
* `name:howl labels.env:dev` --> The instance's name contains "howl" and
                               it has the label "env" with its value
                               containing "dev".
See also

google.spanner.admin.instance.v1.ListInstancesRequest definition in proto format

ListInstancesResponse

static

The response for ListInstances.

Properties

Parameter

instances

Array of Object

The list of requested instances.

This object should have the same structure as Instance

nextPageToken

string

next_page_token can be sent in a subsequent ListInstances call to fetch more of the matching instances.

See also

google.spanner.admin.instance.v1.ListInstancesResponse definition in proto format

UpdateInstanceMetadata

static

Metadata type for the operation returned by UpdateInstance.

Properties

Parameter

instance

Object

The desired end state of the update.

This object should have the same structure as Instance

startTime

Object

The time at which UpdateInstance request was received.

This object should have the same structure as Timestamp

cancelTime

Object

The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.

This object should have the same structure as Timestamp

endTime

Object

The time at which this operation failed or was completed successfully.

This object should have the same structure as Timestamp

See also

google.spanner.admin.instance.v1.UpdateInstanceMetadata definition in proto format

UpdateInstanceRequest

static

The request for UpdateInstance.

Properties

Parameter

instance

Object

Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.

This object should have the same structure as Instance

fieldMask

Object

Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.

This object should have the same structure as FieldMask

See also

google.spanner.admin.instance.v1.UpdateInstanceRequest definition in proto format