Cloud Bigtable V2 Client - Class Instance (1.27.0)

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 \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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

(OutputOnly) 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 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.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getState

(OutputOnly) The current state of the instance.

Returns
TypeDescription
int

setState

(OutputOnly) The current state of the instance.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getType

The type of the instance. Defaults to PRODUCTION.

Returns
TypeDescription
int

setType

The type of the instance. Defaults to PRODUCTION.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
TypeDescription
bool

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this