Class: OCI::ContainerEngine::Models::VirtualNode

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

Overview

The properties that define a virtual 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_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ VirtualNode

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :kubernetes_version (String) —

    The value to assign to the #kubernetes_version property

  • :virtual_node_pool_id (String) —

    The value to assign to the #virtual_node_pool_id 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

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :private_ip (String) —

    The value to assign to the #private_ip property

  • :virtual_node_error (String) —

    The value to assign to the #virtual_node_error 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

  • :time_created (DateTime) —

    The value to assign to the #time_created 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



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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 165

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

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

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

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

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

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

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

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

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

  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']

  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.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']
end

Instance Attribute Details

#availability_domain ⇒ String

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

Returns:

  • (String) 


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

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


87
88
89
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 87

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of the virtual node.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#fault_domain ⇒ String

The fault domain of this virtual node.

Returns:

  • (String) 


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

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


80
81
82
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 80

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The ocid of the virtual node.

Returns:

  • (String) 


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

def id
  @id
end

#kubernetes_version ⇒ String

The version of Kubernetes this virtual node is running.

Returns:

  • (String) 


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

def kubernetes_version
  @kubernetes_version
end

#lifecycle_details ⇒ String

Details about the state of the Virtual Node.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 69

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The state of the Virtual Node.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

NSG Ids applied to virtual node vnic.

Returns:

  • (Array<String>) 


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

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ String

The private IP address of this Virtual Node.

Returns:

  • (String) 


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

def private_ip
  @private_ip
end

#subnet_id ⇒ String

The OCID of the subnet in which this Virtual Node is placed.

Returns:

  • (String) 


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

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


93
94
95
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 93

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time at which the virtual node was created.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 73

def time_created
  @time_created
end

#virtual_node_error ⇒ String

An error that may be associated with the virtual node.

Returns:

  • (String) 


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

def virtual_node_error
  @virtual_node_error
end

#virtual_node_pool_id ⇒ String

[Required] The ocid of the virtual node pool this virtual node belongs to.

Returns:

  • (String) 


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

def virtual_node_pool_id
  @virtual_node_pool_id
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 96

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'kubernetes_version': :'kubernetesVersion',
    'virtual_node_pool_id': :'virtualNodePoolId',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'private_ip': :'privateIp',
    'virtual_node_error': :'virtualNodeError',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'kubernetes_version': :'String',
    'virtual_node_pool_id': :'String',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'private_ip': :'String',
    'virtual_node_error': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 284

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    kubernetes_version == other.kubernetes_version &&
    virtual_node_pool_id == other.virtual_node_pool_id &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    private_ip == other.private_ip &&
    virtual_node_error == other.virtual_node_error &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 329

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


309
310
311
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 309

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 318

def hash
  [id, display_name, kubernetes_version, virtual_node_pool_id, availability_domain, fault_domain, subnet_id, nsg_ids, private_ip, virtual_node_error, lifecycle_state, lifecycle_details, time_created, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 362

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



356
357
358
 
# File 'lib/oci/container_engine/models/virtual_node.rb', line 356

def to_s
  to_hash.to_s
end