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

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

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



1209
1210
1211
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1209

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


1173
1174
1175
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1173

def create_time
  @create_time
end

#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)


1179
1180
1181
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1179

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 propertylabels`

Returns:

  • (Hash<String,String>)


1191
1192
1193
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1191

def labels
  @labels
end

#nameString

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)


1197
1198
1199
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1197

def name
  @name
end

#stateString

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

Returns:

  • (String)


1202
1203
1204
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1202

def state
  @state
end

#typeString

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

Returns:

  • (String)


1207
1208
1209
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1207

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1214
1215
1216
1217
1218
1219
1220
1221
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1214

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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