Class: IntersightClient::KubernetesNodeGroupProfile

Inherits:
PolicyAbstractConfigProfile show all
Defined in:
lib/intersight_client/models/kubernetes_node_group_profile.rb

Overview

A configuration profile for a node group in a Kubernetes cluster.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractConfigProfile

#action, #config_context, #policy_bucket

Attributes inherited from PolicyAbstractProfile

#description, #name, #src_template, #type

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KubernetesNodeGroupProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



153
154
155
156
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
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
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 153

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::KubernetesNodeGroupProfile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'kubernetes.NodeGroupProfile'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'kubernetes.NodeGroupProfile'
  end

  if attributes.key?(:'currentsize')
    self.currentsize = attributes[:'currentsize']
  end

  if attributes.key?(:'desiredsize')
    self.desiredsize = attributes[:'desiredsize']
  else
    self.desiredsize = 3
  end

  if attributes.key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

  if attributes.key?(:'maxsize')
    self.maxsize = attributes[:'maxsize']
  end

  if attributes.key?(:'minsize')
    self.minsize = attributes[:'minsize']
  end

  if attributes.key?(:'node_type')
    self.node_type = attributes[:'node_type']
  else
    self.node_type = 'Worker'
  end

  if attributes.key?(:'taints')
    if (value = attributes[:'taints']).is_a?(Array)
      self.taints = value
    end
  end

  if attributes.key?(:'cluster_profile')
    self.cluster_profile = attributes[:'cluster_profile']
  end

  if attributes.key?(:'infra_provider')
    self.infra_provider = attributes[:'infra_provider']
  end

  if attributes.key?(:'ip_pools')
    if (value = attributes[:'ip_pools']).is_a?(Array)
      self.ip_pools = value
    end
  end

  if attributes.key?(:'kubernetes_version')
    self.kubernetes_version = attributes[:'kubernetes_version']
  end

  if attributes.key?(:'nodes')
    if (value = attributes[:'nodes']).is_a?(Array)
      self.nodes = value
    end
  end
end

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 20

def class_id
  @class_id
end

#cluster_profile ⇒ Object

Returns the value of attribute cluster_profile.



44
45
46
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 44

def cluster_profile
  @cluster_profile
end

#currentsize ⇒ Object

Current number of nodes in this node group at any given point in time.



26
27
28
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 26

def currentsize
  @currentsize
end

#desiredsize ⇒ Object

Desired number of nodes in this node group, same as minsize initially and is updated by the auto-scaler.



29
30
31
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 29

def desiredsize
  @desiredsize
end

#infra_provider ⇒ Object

Returns the value of attribute infra_provider.



46
47
48
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 46

def infra_provider
  @infra_provider
end

#ip_pools ⇒ Object

An array of relationships to ippoolPool resources.



49
50
51
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 49

def ip_pools
  @ip_pools
end

#kubernetes_version ⇒ Object

Returns the value of attribute kubernetes_version.



51
52
53
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 51

def kubernetes_version
  @kubernetes_version
end

#labels ⇒ Object

Returns the value of attribute labels.



31
32
33
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 31

def labels
  @labels
end

#maxsize ⇒ Object

Maximum number of nodes this node group can scale up to during repair, replacement or upgrade operations.



34
35
36
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 34

def maxsize
  @maxsize
end

#minsize ⇒ Object

Minimum number of available nodes this node group can scale down to during repair, replacement or upgrade operations.



37
38
39
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 37

def minsize
  @minsize
end

#node_type ⇒ Object

The node type ControlPlane, Worker or ControlPlaneWorker. * ‘Worker` - Node will be marked as a worker node. * `ControlPlane` - Node will be marked as a control plane node. * `ControlPlaneWorker` - Node will be both a controle plane and a worker.



40
41
42
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 40

def node_type
  @node_type
end

#nodes ⇒ Object

An array of relationships to kubernetesNodeProfile resources.



54
55
56
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 54

def nodes
  @nodes
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 23

def object_type
  @object_type
end

#taints ⇒ Object

Returns the value of attribute taints.



42
43
44
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 42

def taints
  @taints
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



104
105
106
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 104

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



99
100
101
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 99

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 79

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'currentsize' => :'Currentsize',
    :'desiredsize' => :'Desiredsize',
    :'labels' => :'Labels',
    :'maxsize' => :'Maxsize',
    :'minsize' => :'Minsize',
    :'node_type' => :'NodeType',
    :'taints' => :'Taints',
    :'cluster_profile' => :'ClusterProfile',
    :'infra_provider' => :'InfraProvider',
    :'ip_pools' => :'IpPools',
    :'kubernetes_version' => :'KubernetesVersion',
    :'nodes' => :'Nodes'
  }
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



382
383
384
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 382

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



139
140
141
142
143
144
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 139

def self.openapi_all_of
  [
  :'KubernetesNodeGroupProfileAllOf',
  :'PolicyAbstractConfigProfile'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



147
148
149
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 147

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



129
130
131
132
133
134
135
136
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 129

def self.openapi_nullable
  Set.new([
    :'labels',
    :'taints',
    :'ip_pools',
    :'nodes'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 109

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'currentsize' => :'Integer',
    :'desiredsize' => :'Integer',
    :'labels' => :'Array<KubernetesNodeGroupLabel>',
    :'maxsize' => :'Integer',
    :'minsize' => :'Integer',
    :'node_type' => :'String',
    :'taints' => :'Array<KubernetesNodeGroupTaint>',
    :'cluster_profile' => :'KubernetesClusterProfileRelationship',
    :'infra_provider' => :'KubernetesBaseInfrastructureProviderRelationship',
    :'ip_pools' => :'Array<IppoolPoolRelationship>',
    :'kubernetes_version' => :'KubernetesVersionPolicyRelationship',
    :'nodes' => :'Array<KubernetesNodeProfileRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 348

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      currentsize == o.currentsize &&
      desiredsize == o.desiredsize &&
      labels == o.labels &&
      maxsize == o.maxsize &&
      minsize == o.minsize &&
      node_type == o.node_type &&
      taints == o.taints &&
      cluster_profile == o.cluster_profile &&
      infra_provider == o.infra_provider &&
      ip_pools == o.ip_pools &&
      kubernetes_version == o.kubernetes_version &&
      nodes == o.nodes && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 413

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 484

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 389

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  KubernetesNodeGroupProfile.openapi_types.each_pair do |key, type|
    if attributes[KubernetesNodeGroupProfile.attribute_map[key]].nil? && KubernetesNodeGroupProfile.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[KubernetesNodeGroupProfile.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[KubernetesNodeGroupProfile.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[KubernetesNodeGroupProfile.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[KubernetesNodeGroupProfile.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


369
370
371
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 369

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



375
376
377
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 375

def hash
  [class_id, object_type, currentsize, desiredsize, labels, maxsize, minsize, node_type, taints, cluster_profile, infra_provider, ip_pools, kubernetes_version, nodes].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 244

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  if !@desiredsize.nil? && @desiredsize < 0
    invalid_properties.push('invalid value for "desiredsize", must be greater than or equal to 0.')
  end

  if !@maxsize.nil? && @maxsize < 1
    invalid_properties.push('invalid value for "maxsize", must be greater than or equal to 1.')
  end

  if !@minsize.nil? && @minsize < 0
    invalid_properties.push('invalid value for "minsize", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



460
461
462
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 460

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 466

def to_hash
  hash = super
  KubernetesNodeGroupProfile.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = KubernetesNodeGroupProfile.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



454
455
456
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 454

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/intersight_client/models/kubernetes_node_group_profile.rb', line 271

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["kubernetes.NodeGroupProfile"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["kubernetes.NodeGroupProfile"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@desiredsize.nil? && @desiredsize < 0
  return false if !@maxsize.nil? && @maxsize < 1
  return false if !@minsize.nil? && @minsize < 0
  node_type_validator = EnumAttributeValidator.new('String', ["Worker", "ControlPlane", "ControlPlaneWorker"])
  return false unless node_type_validator.valid?(@node_type)
  true && super
end