Class: OCI::Bds::Models::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/node.rb

Overview

Details about a node.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze,
  LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
NODE_TYPE_ENUM = 
[
  NODE_TYPE_MASTER = 'MASTER'.freeze,
  NODE_TYPE_EDGE = 'EDGE'.freeze,
  NODE_TYPE_UTILITY = 'UTILITY'.freeze,
  NODE_TYPE_WORKER = 'WORKER'.freeze,
  NODE_TYPE_COMPUTE_ONLY_WORKER = 'COMPUTE_ONLY_WORKER'.freeze,
  NODE_TYPE_KAFKA_BROKER = 'KAFKA_BROKER'.freeze,
  NODE_TYPE_BURSTING = 'BURSTING'.freeze,
  NODE_TYPE_CLOUD_SQL = 'CLOUD_SQL'.freeze,
  NODE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Node

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :node_type (String) —

    The value to assign to the #node_type property

  • :shape (String) —

    The value to assign to the #shape property

  • :attached_block_volumes (Array<OCI::Bds::Models::VolumeAttachmentDetail>) —

    The value to assign to the #attached_block_volumes property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :hostname (String) —

    The value to assign to the #hostname property

  • :image_id (String) —

    The value to assign to the #image_id property

  • :ssh_fingerprint (String) —

    The value to assign to the #ssh_fingerprint property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :fault_domain (String) —

    The value to assign to the #fault_domain property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :ocpus (Integer) —

    The value to assign to the #ocpus property

  • :memory_in_gbs (Integer) —

    The value to assign to the #memory_in_gbs property

  • :nvmes (Integer) —

    The value to assign to the #nvmes property

  • :local_disks_total_size_in_gbs (Float) —

    The value to assign to the #local_disks_total_size_in_gbs property

  • :time_maintenance_reboot_due (DateTime) —

    The value to assign to the #time_maintenance_reboot_due property

  • :os_version (String) —

    The value to assign to the #os_version property

  • :is_reboot_required (BOOLEAN) —

    The value to assign to the #is_reboot_required property



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/bds/models/node.rb', line 214

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId']

  raise 'You cannot provide both :instanceId and :instance_id' if attributes.key?(:'instanceId') && attributes.key?(:'instance_id')

  self.instance_id = attributes[:'instance_id'] if attributes[:'instance_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.node_type = attributes[:'nodeType'] if attributes[:'nodeType']

  raise 'You cannot provide both :nodeType and :node_type' if attributes.key?(:'nodeType') && attributes.key?(:'node_type')

  self.node_type = attributes[:'node_type'] if attributes[:'node_type']

  self.shape = attributes[:'shape'] if attributes[:'shape']

  self.attached_block_volumes = attributes[:'attachedBlockVolumes'] if attributes[:'attachedBlockVolumes']

  raise 'You cannot provide both :attachedBlockVolumes and :attached_block_volumes' if attributes.key?(:'attachedBlockVolumes') && attributes.key?(:'attached_block_volumes')

  self.attached_block_volumes = attributes[:'attached_block_volumes'] if attributes[:'attached_block_volumes']

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

  raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id')

  self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id']

  self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']

  raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address')

  self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address']

  self.hostname = attributes[:'hostname'] if attributes[:'hostname']

  self.image_id = attributes[:'imageId'] if attributes[:'imageId']

  raise 'You cannot provide both :imageId and :image_id' if attributes.key?(:'imageId') && attributes.key?(:'image_id')

  self.image_id = attributes[:'image_id'] if attributes[:'image_id']

  self.ssh_fingerprint = attributes[:'sshFingerprint'] if attributes[:'sshFingerprint']

  raise 'You cannot provide both :sshFingerprint and :ssh_fingerprint' if attributes.key?(:'sshFingerprint') && attributes.key?(:'ssh_fingerprint')

  self.ssh_fingerprint = attributes[:'ssh_fingerprint'] if attributes[:'ssh_fingerprint']

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

  raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')

  self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']

  self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

  raise 'You cannot provide both :faultDomain and :fault_domain' if attributes.key?(:'faultDomain') && attributes.key?(:'fault_domain')

  self.fault_domain = attributes[:'fault_domain'] if attributes[:'fault_domain']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.ocpus = attributes[:'ocpus'] if attributes[:'ocpus']

  self.memory_in_gbs = attributes[:'memoryInGBs'] if attributes[:'memoryInGBs']

  raise 'You cannot provide both :memoryInGBs and :memory_in_gbs' if attributes.key?(:'memoryInGBs') && attributes.key?(:'memory_in_gbs')

  self.memory_in_gbs = attributes[:'memory_in_gbs'] if attributes[:'memory_in_gbs']

  self.nvmes = attributes[:'nvmes'] if attributes[:'nvmes']

  self.local_disks_total_size_in_gbs = attributes[:'localDisksTotalSizeInGBs'] if attributes[:'localDisksTotalSizeInGBs']

  raise 'You cannot provide both :localDisksTotalSizeInGBs and :local_disks_total_size_in_gbs' if attributes.key?(:'localDisksTotalSizeInGBs') && attributes.key?(:'local_disks_total_size_in_gbs')

  self.local_disks_total_size_in_gbs = attributes[:'local_disks_total_size_in_gbs'] if attributes[:'local_disks_total_size_in_gbs']

  self.time_maintenance_reboot_due = attributes[:'timeMaintenanceRebootDue'] if attributes[:'timeMaintenanceRebootDue']

  raise 'You cannot provide both :timeMaintenanceRebootDue and :time_maintenance_reboot_due' if attributes.key?(:'timeMaintenanceRebootDue') && attributes.key?(:'time_maintenance_reboot_due')

  self.time_maintenance_reboot_due = attributes[:'time_maintenance_reboot_due'] if attributes[:'time_maintenance_reboot_due']

  self.os_version = attributes[:'osVersion'] if attributes[:'osVersion']
  self.os_version = "OL7.9" if os_version.nil? && !attributes.key?(:'osVersion') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :osVersion and :os_version' if attributes.key?(:'osVersion') && attributes.key?(:'os_version')

  self.os_version = attributes[:'os_version'] if attributes[:'os_version']
  self.os_version = "OL7.9" if os_version.nil? && !attributes.key?(:'osVersion') && !attributes.key?(:'os_version') # rubocop:disable Style/StringLiterals

  self.is_reboot_required = attributes[:'isRebootRequired'] unless attributes[:'isRebootRequired'].nil?
  self.is_reboot_required = false if is_reboot_required.nil? && !attributes.key?(:'isRebootRequired') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isRebootRequired and :is_reboot_required' if attributes.key?(:'isRebootRequired') && attributes.key?(:'is_reboot_required')

  self.is_reboot_required = attributes[:'is_reboot_required'] unless attributes[:'is_reboot_required'].nil?
  self.is_reboot_required = false if is_reboot_required.nil? && !attributes.key?(:'isRebootRequired') && !attributes.key?(:'is_reboot_required') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#attached_block_volumes ⇒ Array<OCI::Bds::Models::VolumeAttachmentDetail>

The list of block volumes attached to a given node.

Returns:



60
61
62
 
# File 'lib/oci/bds/models/node.rb', line 60

def attached_block_volumes
  @attached_block_volumes
end

#availability_domain ⇒ String

[Required] The name of the availability domain in which the node is running.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/bds/models/node.rb', line 84

def availability_domain
  @availability_domain
end

#display_name ⇒ String

[Required] The name of the node.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/bds/models/node.rb', line 44

def display_name
  @display_name
end

#fault_domain ⇒ String

[Required] The name of the fault domain in which the node is running.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/bds/models/node.rb', line 88

def fault_domain
  @fault_domain
end

#hostname ⇒ String

The fully-qualified hostname (FQDN) of the node.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/bds/models/node.rb', line 72

def hostname
  @hostname
end

#image_id ⇒ String

The OCID of the image from which the node was created.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/bds/models/node.rb', line 76

def image_id
  @image_id
end

#instance_id ⇒ String

[Required] The OCID of the underlying Oracle Cloud Infrastructure Compute instance.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/bds/models/node.rb', line 40

def instance_id
  @instance_id
end

#ip_address ⇒ String

[Required] IP address of the node.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/bds/models/node.rb', line 68

def ip_address
  @ip_address
end

#is_reboot_required ⇒ BOOLEAN

Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot.

Returns:

  • (BOOLEAN) 


124
125
126
 
# File 'lib/oci/bds/models/node.rb', line 124

def is_reboot_required
  @is_reboot_required
end

#lifecycle_state ⇒ String

[Required] The state of the node.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/bds/models/node.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#local_disks_total_size_in_gbs ⇒ Float

The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.

Returns:

  • (Float) 


112
113
114
 
# File 'lib/oci/bds/models/node.rb', line 112

def local_disks_total_size_in_gbs
  @local_disks_total_size_in_gbs
end

#memory_in_gbs ⇒ Integer

The total amount of memory available to the node, in gigabytes.

Returns:

  • (Integer) 


104
105
106
 
# File 'lib/oci/bds/models/node.rb', line 104

def memory_in_gbs
  @memory_in_gbs
end

#node_type ⇒ String

[Required] Cluster node type.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/bds/models/node.rb', line 52

def node_type
  @node_type
end

#nvmes ⇒ Integer

The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.

Returns:

  • (Integer) 


108
109
110
 
# File 'lib/oci/bds/models/node.rb', line 108

def nvmes
  @nvmes
end

#ocpus ⇒ Integer

The total number of OCPUs available to the node.

Returns:

  • (Integer) 


100
101
102
 
# File 'lib/oci/bds/models/node.rb', line 100

def ocpus
  @ocpus
end

#os_version ⇒ String

BDS-assigned Operating System version for the node.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/bds/models/node.rb', line 120

def os_version
  @os_version
end

#shape ⇒ String

[Required] Shape of the node.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/bds/models/node.rb', line 56

def shape
  @shape
end

#ssh_fingerprint ⇒ String

[Required] The fingerprint of the SSH key used for node access.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/bds/models/node.rb', line 80

def ssh_fingerprint
  @ssh_fingerprint
end

#subnet_id ⇒ String

[Required] The OCID of the subnet in which the node is to be created.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/bds/models/node.rb', line 64

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

[Required] The time the node was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/bds/models/node.rb', line 92

def time_created
  @time_created
end

#time_maintenance_reboot_due ⇒ DateTime

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/bds/models/node.rb', line 116

def time_maintenance_reboot_due
  @time_maintenance_reboot_due
end

#time_updated ⇒ DateTime

The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


96
97
98
 
# File 'lib/oci/bds/models/node.rb', line 96

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/bds/models/node.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_id': :'instanceId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'node_type': :'nodeType',
    'shape': :'shape',
    'attached_block_volumes': :'attachedBlockVolumes',
    'subnet_id': :'subnetId',
    'ip_address': :'ipAddress',
    'hostname': :'hostname',
    'image_id': :'imageId',
    'ssh_fingerprint': :'sshFingerprint',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'ocpus': :'ocpus',
    'memory_in_gbs': :'memoryInGBs',
    'nvmes': :'nvmes',
    'local_disks_total_size_in_gbs': :'localDisksTotalSizeInGBs',
    'time_maintenance_reboot_due': :'timeMaintenanceRebootDue',
    'os_version': :'osVersion',
    'is_reboot_required': :'isRebootRequired'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/bds/models/node.rb', line 157

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'node_type': :'String',
    'shape': :'String',
    'attached_block_volumes': :'Array<OCI::Bds::Models::VolumeAttachmentDetail>',
    'subnet_id': :'String',
    'ip_address': :'String',
    'hostname': :'String',
    'image_id': :'String',
    'ssh_fingerprint': :'String',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'ocpus': :'Integer',
    'memory_in_gbs': :'Integer',
    'nvmes': :'Integer',
    'local_disks_total_size_in_gbs': :'Float',
    'time_maintenance_reboot_due': :'DateTime',
    'os_version': :'String',
    'is_reboot_required': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/oci/bds/models/node.rb', line 374

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    instance_id == other.instance_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    node_type == other.node_type &&
    shape == other.shape &&
    attached_block_volumes == other.attached_block_volumes &&
    subnet_id == other.subnet_id &&
    ip_address == other.ip_address &&
    hostname == other.hostname &&
    image_id == other.image_id &&
    ssh_fingerprint == other.ssh_fingerprint &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    ocpus == other.ocpus &&
    memory_in_gbs == other.memory_in_gbs &&
    nvmes == other.nvmes &&
    local_disks_total_size_in_gbs == other.local_disks_total_size_in_gbs &&
    time_maintenance_reboot_due == other.time_maintenance_reboot_due &&
    os_version == other.os_version &&
    is_reboot_required == other.is_reboot_required
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/oci/bds/models/node.rb', line 425

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


405
406
407
 
# File 'lib/oci/bds/models/node.rb', line 405

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



414
415
416
 
# File 'lib/oci/bds/models/node.rb', line 414

def hash
  [instance_id, display_name, lifecycle_state, node_type, shape, attached_block_volumes, subnet_id, ip_address, hostname, image_id, ssh_fingerprint, availability_domain, fault_domain, time_created, time_updated, ocpus, memory_in_gbs, nvmes, local_disks_total_size_in_gbs, time_maintenance_reboot_due, os_version, is_reboot_required].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



458
459
460
461
462
463
464
465
466
467
 
# File 'lib/oci/bds/models/node.rb', line 458

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



452
453
454
 
# File 'lib/oci/bds/models/node.rb', line 452

def to_s
  to_hash.to_s
end