Class: Google::Apis::BigtableadminV1::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigtableadmin_v1/classes.rb,
lib/google/apis/bigtableadmin_v1/representations.rb,
lib/google/apis/bigtableadmin_v1/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

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



538
539
540
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 538

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

Instance Attribute Details

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

Returns:

  • (String) 


508
509
510
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 508

def display_name
  @display_name
end

#labels ⇒ Hash<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 propertylabels`

Returns:

  • (Hash<String,String>) 


520
521
522
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 520

def labels
  @labels
end

#name ⇒ String

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) 


526
527
528
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 526

def name
  @name
end

#state ⇒ String

Output only. The current state of the instance. Corresponds to the JSON property state

Returns:

  • (String) 


531
532
533
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 531

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


536
537
538
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 536

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



543
544
545
546
547
548
549
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 543

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