Class: OCI::ContainerEngine::Models::Node

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

Overview

The properties that define a node.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILING = 'FAILING'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_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):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :kubernetes_version (String) —

    The value to assign to the #kubernetes_version property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :node_pool_id (String) —

    The value to assign to the #node_pool_id property

  • :fault_domain (String) —

    The value to assign to the #fault_domain property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :public_ip (String) —

    The value to assign to the #public_ip property

  • :node_error (OCI::ContainerEngine::Models::NodeError) —

    The value to assign to the #node_error property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
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
 
# File 'lib/oci/container_engine/models/node.rb', line 158

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.id = attributes[:'id'] if attributes[:'id']

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

  self.kubernetes_version = attributes[:'kubernetesVersion'] if attributes[:'kubernetesVersion']

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

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

  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.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.node_pool_id = attributes[:'nodePoolId'] if attributes[:'nodePoolId']

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

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

  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.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

  self.public_ip = attributes[:'publicIp'] if attributes[:'publicIp']

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

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

  self.node_error = attributes[:'nodeError'] if attributes[:'nodeError']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']
end

Instance Attribute Details

#availability_domain ⇒ String

The name of the availability domain in which this node is placed.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/container_engine/models/node.rb', line 37

def availability_domain
  @availability_domain
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


75
76
77
 
# File 'lib/oci/container_engine/models/node.rb', line 75

def defined_tags
  @defined_tags
end

#fault_domain ⇒ String

The fault domain of this node.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/container_engine/models/node.rb', line 49

def fault_domain
  @fault_domain
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the compute instance backing this node.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/container_engine/models/node.rb', line 25

def id
  @id
end

#kubernetes_version ⇒ String

The version of Kubernetes this node is running.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/container_engine/models/node.rb', line 33

def kubernetes_version
  @kubernetes_version
end

#lifecycle_details ⇒ String

Details about the state of the node.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/container_engine/models/node.rb', line 89

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The state of the node.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/container_engine/models/node.rb', line 85

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name of the node.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/container_engine/models/node.rb', line 29

def name
  @name
end

#node_error ⇒ OCI::ContainerEngine::Models::NodeError

An error that may be associated with the node.

Returns:



61
62
63
 
# File 'lib/oci/container_engine/models/node.rb', line 61

def node_error
  @node_error
end

#node_pool_id ⇒ String

The OCID of the node pool to which this node belongs.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/container_engine/models/node.rb', line 45

def node_pool_id
  @node_pool_id
end

#private_ip ⇒ String

The private IP address of this node.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/container_engine/models/node.rb', line 53

def private_ip
  @private_ip
end

#public_ip ⇒ String

The public IP address of this node.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/container_engine/models/node.rb', line 57

def public_ip
  @public_ip
end

#subnet_id ⇒ String

The OCID of the subnet in which this node is placed.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/container_engine/models/node.rb', line 41

def subnet_id
  @subnet_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


81
82
83
 
# File 'lib/oci/container_engine/models/node.rb', line 81

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/container_engine/models/node.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'kubernetes_version': :'kubernetesVersion',
    'availability_domain': :'availabilityDomain',
    'subnet_id': :'subnetId',
    'node_pool_id': :'nodePoolId',
    'fault_domain': :'faultDomain',
    'private_ip': :'privateIp',
    'public_ip': :'publicIp',
    'node_error': :'nodeError',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/container_engine/models/node.rb', line 115

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'kubernetes_version': :'String',
    'availability_domain': :'String',
    'subnet_id': :'String',
    'node_pool_id': :'String',
    'fault_domain': :'String',
    'private_ip': :'String',
    'public_ip': :'String',
    'node_error': :'OCI::ContainerEngine::Models::NodeError',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String'
    # 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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/container_engine/models/node.rb', line 267

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    kubernetes_version == other.kubernetes_version &&
    availability_domain == other.availability_domain &&
    subnet_id == other.subnet_id &&
    node_pool_id == other.node_pool_id &&
    fault_domain == other.fault_domain &&
    private_ip == other.private_ip &&
    public_ip == other.public_ip &&
    node_error == other.node_error &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/container_engine/models/node.rb', line 311

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


291
292
293
 
# File 'lib/oci/container_engine/models/node.rb', line 291

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/oci/container_engine/models/node.rb', line 300

def hash
  [id, name, kubernetes_version, availability_domain, subnet_id, node_pool_id, fault_domain, private_ip, public_ip, node_error, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/container_engine/models/node.rb', line 344

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



338
339
340
 
# File 'lib/oci/container_engine/models/node.rb', line 338

def to_s
  to_hash.to_s
end