Reference documentation and code samples for the Cloud Bigtable V2 Client class 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.
Generated from protobuf message google.bigtable.admin.v2.Instance
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique name of the instance. Values are of the form projects/{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.
↳ state
int
Output only. The current state of the instance.
↳ type
int
The type of the instance. Defaults to PRODUCTION
.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ create_time
Google\Protobuf\Timestamp
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
.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
↳ tags
array| Google\Protobuf\Internal\MapField
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.
getName
The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]
.
string
setName
The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]
.
var
string
$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.
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.
var
string
$this
getState
Output only. The current state of the instance.
int
setState
Output only. The current state of the instance.
var
int
$this
getType
The type of the instance. Defaults to PRODUCTION
.
int
setType
The type of the instance. Defaults to PRODUCTION
.
var
int
$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.
- Keys and values must both be under 128 bytes.
setLabels
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.
$this
getCreateTime
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
.
hasCreateTime
clearCreateTime
setCreateTime
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
.
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
getTags
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.
setTags
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.
$this
