Class: OCI::ContainerEngine::Models::CreateNodePoolDetails

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

Overview

The properties that define a request to create 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 = {}) ⇒ CreateNodePoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.cluster_id = attributes[:'clusterId'] if attributes[:'clusterId']

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

  self.cluster_id = attributes[:'cluster_id'] if attributes[:'cluster_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.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_image_name = attributes[:'nodeImageName'] if attributes[:'nodeImageName']

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

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

  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.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.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.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.quantity_per_subnet = attributes[:'quantityPerSubnet'] if attributes[:'quantityPerSubnet']
  self.quantity_per_subnet = 1 if quantity_per_subnet.nil? && !attributes.key?(:'quantityPerSubnet') # rubocop:disable Style/StringLiterals

  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.quantity_per_subnet = 1 if quantity_per_subnet.nil? && !attributes.key?(:'quantityPerSubnet') && !attributes.key?(:'quantity_per_subnet') # rubocop:disable Style/StringLiterals

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

#cluster_id ⇒ String

[Required] The OCID of the cluster to which this node pool is attached.

Returns:

  • (String) 


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

def cluster_id
  @cluster_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the node pool exists.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
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>>) 


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

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


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

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:



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

def initial_node_labels
  @initial_node_labels
end

#kubernetes_version ⇒ String

The version of Kubernetes to install on the nodes in the node pool.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 31

def kubernetes_version
  @kubernetes_version
end

#name ⇒ String

[Required] The name of the node pool. Avoid entering confidential information.

Returns:

  • (String) 


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

def name
  @name
end

#network_launch_type ⇒ String

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

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 111

def network_launch_type
  @network_launch_type
end

#node_config_details ⇒ OCI::ContainerEngine::Models::CreateNodePoolNodeConfigDetails

The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns:



83
84
85
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 83

def node_config_details
  @node_config_details
end

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

Returns:



100
101
102
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 100

def node_eviction_node_pool_settings
  @node_eviction_node_pool_settings
end

#node_image_name ⇒ String

Deprecated. Use nodeSourceDetails instead. If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 42

def node_image_name
  @node_image_name
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>) 


35
36
37
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 35

def node_metadata
  @node_metadata
end

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

Returns:



103
104
105
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 103

def node_pool_cycling_details
  @node_pool_cycling_details
end

#node_shape ⇒ String

[Required] The name of the node shape of the nodes in the node pool.

Returns:

  • (String) 


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

def node_shape
  @node_shape
end

#node_shape_config ⇒ OCI::ContainerEngine::Models::CreateNodeShapeConfigDetails

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

Returns:



56
57
58
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 56

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:



47
48
49
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 47

def node_source_details
  @node_source_details
end

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

Returns:



114
115
116
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 114

def primary_vnic
  @primary_vnic
end

#quantity_per_subnet ⇒ Integer

Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead.

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 70

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:



107
108
109
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 107

def secondary_vnics
  @secondary_vnics
end

#ssh_public_key ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/container_engine/models/create_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. When used, quantityPerSubnet can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns:

  • (Array<String>) 


77
78
79
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 77

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cluster_id': :'clusterId',
    'name': :'name',
    'kubernetes_version': :'kubernetesVersion',
    'node_metadata': :'nodeMetadata',
    'node_image_name': :'nodeImageName',
    'node_source_details': :'nodeSourceDetails',
    'node_shape': :'nodeShape',
    'node_shape_config': :'nodeShapeConfig',
    'initial_node_labels': :'initialNodeLabels',
    'ssh_public_key': :'sshPublicKey',
    'quantity_per_subnet': :'quantityPerSubnet',
    'subnet_ids': :'subnetIds',
    'node_config_details': :'nodeConfigDetails',
    '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.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'cluster_id': :'String',
    'name': :'String',
    'kubernetes_version': :'String',
    'node_metadata': :'Hash<String, String>',
    'node_image_name': :'String',
    'node_source_details': :'OCI::ContainerEngine::Models::NodeSourceDetails',
    'node_shape': :'String',
    'node_shape_config': :'OCI::ContainerEngine::Models::CreateNodeShapeConfigDetails',
    'initial_node_labels': :'Array<OCI::ContainerEngine::Models::KeyValue>',
    'ssh_public_key': :'String',
    'quantity_per_subnet': :'Integer',
    'subnet_ids': :'Array<String>',
    'node_config_details': :'OCI::ContainerEngine::Models::CreateNodePoolNodeConfigDetails',
    '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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 347

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    cluster_id == other.cluster_id &&
    name == other.name &&
    kubernetes_version == other.kubernetes_version &&
    node_metadata == other.node_metadata &&
    node_image_name == other.node_image_name &&
    node_source_details == other.node_source_details &&
    node_shape == other.node_shape &&
    node_shape_config == other.node_shape_config &&
    initial_node_labels == other.initial_node_labels &&
    ssh_public_key == other.ssh_public_key &&
    quantity_per_subnet == other.quantity_per_subnet &&
    subnet_ids == other.subnet_ids &&
    node_config_details == other.node_config_details &&
    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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 397

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


377
378
379
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 377

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



386
387
388
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 386

def hash
  [compartment_id, cluster_id, name, kubernetes_version, node_metadata, node_image_name, node_source_details, node_shape, node_shape_config, initial_node_labels, ssh_public_key, quantity_per_subnet, subnet_ids, node_config_details, 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



430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 430

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



424
425
426
 
# File 'lib/oci/container_engine/models/create_node_pool_details.rb', line 424

def to_s
  to_hash.to_s
end