REST Resource: projects.instances

Resource: Instance

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

JSON representation 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "type": enum (Type),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].
displayName

string

Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
state

enum (State)

Output only. The current state of the instance.
type

enum (Type)

The type of the instance. Defaults to PRODUCTION.
labels

map (key: string, value: string)

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

  • Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}.
  • No more than 64 labels can be associated with a given resource.
  • Keys and values must both be under 128 bytes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.

State

Possible states of an instance.

Enums
STATE_NOT_KNOWN The state of the instance could not be determined.
READY The instance has been successfully created and can serve requests to its tables.
CREATING The instance is currently being created, and may be destroyed if the creation process encounters an error.

Type

The type of the instance.

Enums
TYPE_UNSPECIFIED The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
PRODUCTION An instance meant for production use. serveNodes must be set on the cluster.
DEVELOPMENT DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces a higher minimum node count than DEVELOPMENT.

Methods

create

 Create an instance within a project.

delete

 Delete an instance from a project.

get

 Gets information about an instance.

getIamPolicy

 Gets the access control policy for an instance resource.

list

 Lists information about instances in a project.

partialUpdateInstance

 Partially updates an instance within a project.

setIamPolicy

 Sets the access control policy on an instance resource.

testIamPermissions

 Returns permissions that the caller has on the specified instance resource.

update

 Updates an instance within a project.