Class: Google::Apis::BigtableadminV2::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigtableadmin_v2/classes.rb,
generated/google/apis/bigtableadmin_v2/representations.rb,
generated/google/apis/bigtableadmin_v2/representations.rb

Overview

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



901
902
903
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 901

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_nameString

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. Corresponds to the JSON property displayName

Returns:

  • (String)


867
868
869
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 867

def display_name
  @display_name
end

#labelsHash<String,String>

Required. 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: \pLl\pLo0,62.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\pLl\pLo\pN_-]0,63``.
  • No more than 64 labels can be associated with a given resource.
  • Keys and values must both be under 128 bytes. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


881
882
883
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 881

def labels
  @labels
end

#nameString

Required. (OutputOnly) The unique name of the instance. Values are of the form projects/project/instances/a-z+[a-z0-9]. Corresponds to the JSON property name

Returns:

  • (String)


888
889
890
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 888

def name
  @name
end

#stateString

(OutputOnly) The current state of the instance. Corresponds to the JSON property state

Returns:

  • (String)


894
895
896
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 894

def state
  @state
end

#typeString

Required. The type of the instance. Defaults to PRODUCTION. Corresponds to the JSON property type

Returns:

  • (String)


899
900
901
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 899

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



906
907
908
909
910
911
912
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 906

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
end