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
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 form |
↳ 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
( |
↳ type |
int
The type of the instance. Defaults to |
↳ 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: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is |
↳ satisfies_pzs |
bool
Output only. Reserved for future use. |
getName
The unique name of the instance. Values are of the form
projects/{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 form
projects/{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
(OutputOnly)
The current state of the instance.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
(OutputOnly)
The current state of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of the instance. Defaults to PRODUCTION.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of the instance. Defaults to PRODUCTION.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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.
- Keys and values must both be under 128 bytes.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. A server-assigned timestamp representing when this Instance was created.
For instances created before this field was added (August 2021), this value
is seconds: 0, nanos: 1.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. A server-assigned timestamp representing when this Instance was created.
For instances created before this field was added (August 2021), this value
is seconds: 0, nanos: 1.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSatisfiesPzs
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |