Reference documentation and code samples for the Cloud Bigtable V2 Client class Instance.
A collection of BigtableTablesand
the resources that serve them.
All tables in an instance are served from allClustersin the instance.
Generated from protobuf messagegoogle.bigtable.admin.v2.Instance
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the instance. Values are of the formprojects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].
↳ display_name
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.
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.
Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value isseconds: 0, nanos: 1.
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. Seehttps://cloud.google.com/resource-manager/docs/tags/tags-overviewfor an in-depth overview on the difference between tags and labels.
getName
The unique name of the instance. Values are of the formprojects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].
Returns
Type
Description
string
setName
The unique name of the instance. Values are of the formprojects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
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.
Returns
Type
Description
string
setDisplayName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getState
Output only. The current state of the instance.
Returns
Type
Description
int
Enum of typeState.
setState
Output only. The current state of the instance.
Parameter
Name
Description
var
int
Enum of typeState.
Returns
Type
Description
$this
getType
The type of the instance. Defaults toPRODUCTION.
Returns
Type
Description
int
Enum of typeType.
setType
The type of the instance. Defaults toPRODUCTION.
Parameter
Name
Description
var
int
Enum of typeType.
Returns
Type
Description
$this
getLabels
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.
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.
Output only. A commit timestamp representing when this Instance was
created. For instances created before this field was added (August 2021),
this value isseconds: 0, nanos: 1.
Output only. A commit timestamp representing when this Instance was
created. For instances created before this field was added (August 2021),
this value isseconds: 0, nanos: 1.
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. Seehttps://cloud.google.com/resource-manager/docs/tags/tags-overviewfor an
in-depth overview on the difference between tags and labels.
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. Seehttps://cloud.google.com/resource-manager/docs/tags/tags-overviewfor an
in-depth overview on the difference between tags and labels.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class Instance (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Instance)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.Instance)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.Instance)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.Instance)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.Instance)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.Instance)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.Instance)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.Instance)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.Instance)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.Instance)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.Instance)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.Instance)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.Instance)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.Instance)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.Instance)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.Instance)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.Instance)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.Instance)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.Instance)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.Instance)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.Instance)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.Instance)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.Instance)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.Instance)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.Instance)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.Instance)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.Instance)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.Instance)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.Instance)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.Instance)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.Instance) \nReference documentation and code samples for the Cloud Bigtable V2 Client class Instance.\n\nA collection of Bigtable [Tables](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Table) and\nthe resources that serve them.\n\nAll tables in an instance are served from all\n[Clusters](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Cluster) in the instance.\n\nGenerated from protobuf message `google.bigtable.admin.v2.Instance`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/[a-z][a-z0-9\\\\-]+[a-z0-9]`.\n\n### setName\n\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/[a-z][a-z0-9\\\\-]+[a-z0-9]`.\n\n### getDisplayName\n\nRequired. The descriptive name for this instance as it appears in UIs.\n\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.\n\n### setDisplayName\n\nRequired. The descriptive name for this instance as it appears in UIs.\n\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.\n\n### getState\n\nOutput only. The current state of the instance.\n\n### setState\n\nOutput only. The current state of the instance.\n\n### getType\n\nThe type of the instance. Defaults to `PRODUCTION`.\n\n### setType\n\nThe type of the instance. Defaults to `PRODUCTION`.\n\n### getLabels\n\nLabels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n- 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}`.\n- 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}`.\n- No more than 64 labels can be associated with a given resource.\n- Keys and values must both be under 128 bytes.\n\n### setLabels\n\nLabels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n- 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}`.\n- 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}`.\n- No more than 64 labels can be associated with a given resource.\n- Keys and values must both be under 128 bytes.\n\n### getCreateTime\n\nOutput only. A commit timestamp representing when this Instance was\ncreated. For instances created before this field was added (August 2021),\nthis value is `seconds: 0, nanos: 1`.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. A commit timestamp representing when this Instance was\ncreated. For instances created before this field was added (August 2021),\nthis value is `seconds: 0, nanos: 1`.\n\n### getSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### hasSatisfiesPzs\n\n### clearSatisfiesPzs\n\n### setSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### getSatisfiesPzi\n\nOutput only. Reserved for future use.\n\n### hasSatisfiesPzi\n\n### clearSatisfiesPzi\n\n### setSatisfiesPzi\n\nOutput only. Reserved for future use.\n\n### getTags\n\nOptional. Input only. Immutable. Tag keys/values directly bound to this\nresource. For example:\n\n- \"123/environment\": \"production\",\n- \"123/costCenter\": \"marketing\" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-overview\u003e for an in-depth overview on the difference between tags and labels.\n\n### setTags\n\nOptional. Input only. Immutable. Tag keys/values directly bound to this\nresource. For example:\n\n- \"123/environment\": \"production\",\n- \"123/costCenter\": \"marketing\" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-overview\u003e for an in-depth overview on the difference between tags and labels."]]
