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),
  "edition": enum (Edition),
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "tags": {
    string: 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.
edition

enum (Edition)

Optional. The edition of the instance. See Edition for details.
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".
tags

map (key: string, value: string)

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing"

Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.

Edition

Possible editions of an instance.

An edition is a specific tier of Cloud Bigtable. Each edition is tailored to different customer needs. Higher tiers offer more features and better performance.

Enums
EDITION_UNSPECIFIED The edition is unspecified. This is treated as ENTERPRISE.
ENTERPRISE The Enterprise edition. This is the default offering that is designed to meet the needs of most enterprise workloads.
ENTERPRISE_PLUS

The Enterprise Plus edition. This is a premium tier that is designed for demanding, multi-tenant workloads requiring the highest levels of performance, scale, and global availability.

The nodes in the Enterprise Plus tier come at a higher cost than the Enterprise tier. Any Enterprise Plus features must be disabled before downgrading to Enterprise.

Methods

create

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.CreateInstance is not available in Cloud de Confiance by S3NS.

delete

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteInstance is not available in Cloud de Confiance by S3NS.

get

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstance is not available in Cloud de Confiance by S3NS.

getIamPolicy

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.GetIamPolicy is not available in Cloud de Confiance by S3NS.

list

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstances is not available in Cloud de Confiance by S3NS.

partialUpdateInstance

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.PartialUpdateInstance is not available in Cloud de Confiance by S3NS.

setIamPolicy

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.SetIamPolicy is not available in Cloud de Confiance by S3NS.

testIamPermissions

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.TestIamPermissions is not available in Cloud de Confiance by S3NS.

update

 The method google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateInstance is not available in Cloud de Confiance by S3NS.