Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::Instance (v0.18.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#display_name

def display_name() -> ::String
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::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.
Returns
  • (::Google::Protobuf::Map{::String => ::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.

#name

def name() -> ::String
Returns
  • (::String) — The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].
Returns
  • (::String) — The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#state

def state() -> ::Google::Cloud::Bigtable::Admin::V2::Instance::State
Returns

#state=

def state=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Instance::State
Parameter
Returns

#type

def type() -> ::Google::Cloud::Bigtable::Admin::V2::Instance::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Instance::Type
Parameter
Returns