Class: OCI::ContainerEngine::Models::UpdateNodePoolDetails

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

Overview

The properties that define a request to update a node pool.

Constant Summary collapse

NETWORK_LAUNCH_TYPE_ENUM = 
[
  NETWORK_LAUNCH_TYPE_VFIO = 'VFIO'.freeze,
  NETWORK_LAUNCH_TYPE_E1000 = 'E1000'.freeze,
  NETWORK_LAUNCH_TYPE_PARAVIRTUALIZED = 'PARAVIRTUALIZED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateNodePoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 182

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

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

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

  self.quantity_per_subnet = attributes[:'quantityPerSubnet'] if attributes[:'quantityPerSubnet']

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

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

  self.subnet_ids = attributes[:'subnetIds'] if attributes[:'subnetIds']

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

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

  self.node_config_details = attributes[:'nodeConfigDetails'] if attributes[:'nodeConfigDetails']

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

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

  self.node_metadata = attributes[:'nodeMetadata'] if attributes[:'nodeMetadata']

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

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

  self.node_source_details = attributes[:'nodeSourceDetails'] if attributes[:'nodeSourceDetails']

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

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

  self.ssh_public_key = attributes[:'sshPublicKey'] if attributes[:'sshPublicKey']

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

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

  self.node_shape = attributes[:'nodeShape'] if attributes[:'nodeShape']

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

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

  self.node_shape_config = attributes[:'nodeShapeConfig'] if attributes[:'nodeShapeConfig']

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

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

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

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

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

  self.node_pool_cycling_details = attributes[:'nodePoolCyclingDetails'] if attributes[:'nodePoolCyclingDetails']

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

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

  self.secondary_vnics = attributes[:'secondaryVnics'] if attributes[:'secondaryVnics']

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

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

  self.network_launch_type = attributes[:'networkLaunchType'] if attributes[:'networkLaunchType']

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

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

  self.primary_vnic = attributes[:'primaryVnic'] if attributes[:'primaryVnic']

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

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

Instance Attribute Details

#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/update_node_pool_details.rb', line 87

def defined_tags
  @defined_tags
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/update_node_pool_details.rb', line 80

def freeform_tags
  @freeform_tags
end

#initial_node_labels ⇒ Array<OCI::ContainerEngine::Models::KeyValue>

A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

Returns:



27
28
29
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 27

def initial_node_labels
  @initial_node_labels
end

#kubernetes_version ⇒ String

The version of Kubernetes to which the nodes in the node pool should be upgraded.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 23

def kubernetes_version
  @kubernetes_version
end

#name ⇒ String

The new name for the cluster. Avoid entering confidential information.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 19

def name
  @name
end

#network_launch_type ⇒ String

Emulation type for the physical network interface card (NIC) for nodes

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 101

def network_launch_type
  @network_launch_type
end

#node_config_details ⇒ OCI::ContainerEngine::Models::UpdateNodePoolNodeConfigDetails

The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails, you must first scale the node pool to 0 nodes using quantityPerSubnet.

Returns:



51
52
53
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 51

def node_config_details
  @node_config_details
end

#node_eviction_node_pool_settings ⇒ OCI::ContainerEngine::Models::NodeEvictionNodePoolSettings

Returns:



90
91
92
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 90

def node_eviction_node_pool_settings
  @node_eviction_node_pool_settings
end

#node_metadata ⇒ Hash<String, String>

A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

Returns:

  • (Hash<String, String>) 


55
56
57
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 55

def node_metadata
  @node_metadata
end

#node_pool_cycling_details ⇒ OCI::ContainerEngine::Models::NodePoolCyclingDetails

Returns:



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

def node_pool_cycling_details
  @node_pool_cycling_details
end

#node_shape ⇒ String

The name of the node shape of the nodes in the node pool used on launch.

Returns:

  • (String) 


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

def node_shape
  @node_shape
end

#node_shape_config ⇒ OCI::ContainerEngine::Models::UpdateNodeShapeConfigDetails

Specify the configuration of the shape to launch nodes in the node pool.

Returns:



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

def node_shape_config
  @node_shape_config
end

#node_source_details ⇒ OCI::ContainerEngine::Models::NodeSourceDetails

Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

Returns:



60
61
62
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 60

def node_source_details
  @node_source_details
end

#primary_vnic ⇒ OCI::ContainerEngine::Models::NodePoolPrimaryVnicDetails

Returns:



104
105
106
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 104

def primary_vnic
  @primary_vnic
end

#quantity_per_subnet ⇒ Integer

The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated, use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 36

def quantity_per_subnet
  @quantity_per_subnet
end

#secondary_vnics ⇒ Array<OCI::ContainerEngine::Models::NodePoolSecondaryVnicDetails>

A list of secondary vnics to attach to nodes

Returns:



97
98
99
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 97

def secondary_vnics
  @secondary_vnics
end

#ssh_public_key ⇒ String

The SSH public key to add to each node in the node pool on launch.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 64

def ssh_public_key
  @ssh_public_key
end

#subnet_ids ⇒ Array<String>

The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated, use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified.

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 43

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 107

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'kubernetes_version': :'kubernetesVersion',
    'initial_node_labels': :'initialNodeLabels',
    'quantity_per_subnet': :'quantityPerSubnet',
    'subnet_ids': :'subnetIds',
    'node_config_details': :'nodeConfigDetails',
    'node_metadata': :'nodeMetadata',
    'node_source_details': :'nodeSourceDetails',
    'ssh_public_key': :'sshPublicKey',
    'node_shape': :'nodeShape',
    'node_shape_config': :'nodeShapeConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'node_eviction_node_pool_settings': :'nodeEvictionNodePoolSettings',
    'node_pool_cycling_details': :'nodePoolCyclingDetails',
    'secondary_vnics': :'secondaryVnics',
    'network_launch_type': :'networkLaunchType',
    'primary_vnic': :'primaryVnic'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 133

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'kubernetes_version': :'String',
    'initial_node_labels': :'Array<OCI::ContainerEngine::Models::KeyValue>',
    'quantity_per_subnet': :'Integer',
    'subnet_ids': :'Array<String>',
    'node_config_details': :'OCI::ContainerEngine::Models::UpdateNodePoolNodeConfigDetails',
    'node_metadata': :'Hash<String, String>',
    'node_source_details': :'OCI::ContainerEngine::Models::NodeSourceDetails',
    'ssh_public_key': :'String',
    'node_shape': :'String',
    'node_shape_config': :'OCI::ContainerEngine::Models::UpdateNodeShapeConfigDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'node_eviction_node_pool_settings': :'OCI::ContainerEngine::Models::NodeEvictionNodePoolSettings',
    'node_pool_cycling_details': :'OCI::ContainerEngine::Models::NodePoolCyclingDetails',
    'secondary_vnics': :'Array<OCI::ContainerEngine::Models::NodePoolSecondaryVnicDetails>',
    'network_launch_type': :'String',
    'primary_vnic': :'OCI::ContainerEngine::Models::NodePoolPrimaryVnicDetails'
    # 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



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

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

  self.class == other.class &&
    name == other.name &&
    kubernetes_version == other.kubernetes_version &&
    initial_node_labels == other.initial_node_labels &&
    quantity_per_subnet == other.quantity_per_subnet &&
    subnet_ids == other.subnet_ids &&
    node_config_details == other.node_config_details &&
    node_metadata == other.node_metadata &&
    node_source_details == other.node_source_details &&
    ssh_public_key == other.ssh_public_key &&
    node_shape == other.node_shape &&
    node_shape_config == other.node_shape_config &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    node_eviction_node_pool_settings == other.node_eviction_node_pool_settings &&
    node_pool_cycling_details == other.node_pool_cycling_details &&
    secondary_vnics == other.secondary_vnics &&
    network_launch_type == other.network_launch_type &&
    primary_vnic == other.primary_vnic
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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 355

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


335
336
337
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 335

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 344

def hash
  [name, kubernetes_version, initial_node_labels, quantity_per_subnet, subnet_ids, node_config_details, node_metadata, node_source_details, ssh_public_key, node_shape, node_shape_config, freeform_tags, defined_tags, node_eviction_node_pool_settings, node_pool_cycling_details, secondary_vnics, network_launch_type, primary_vnic].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 388

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



382
383
384
 
# File 'lib/oci/container_engine/models/update_node_pool_details.rb', line 382

def to_s
  to_hash.to_s
end