Class: Kubevirt::K8sIoApiCoreV1PodAntiAffinity

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb

Overview

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ K8sIoApiCoreV1PodAntiAffinity

Initializes the object



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 59

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

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

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

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

Instance Attribute Details

#preferred_during_scheduling_ignored_during_executionObject

The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.



20
21
22
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 20

def preferred_during_scheduling_ignored_during_execution
  @preferred_during_scheduling_ignored_during_execution
end

#required_during_scheduling_ignored_during_executionObject

If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.



23
24
25
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 23

def required_during_scheduling_ignored_during_execution
  @required_during_scheduling_ignored_during_execution
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



34
35
36
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 34

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



39
40
41
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 39

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



26
27
28
29
30
31
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 26

def self.attribute_map
  {
    :'preferred_during_scheduling_ignored_during_execution' => :'preferredDuringSchedulingIgnoredDuringExecution',
    :'required_during_scheduling_ignored_during_execution' => :'requiredDuringSchedulingIgnoredDuringExecution'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 125

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



52
53
54
55
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 52

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



44
45
46
47
48
49
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 44

def self.openapi_types
  {
    :'preferred_during_scheduling_ignored_during_execution' => :'Array<K8sIoApiCoreV1WeightedPodAffinityTerm>',
    :'required_during_scheduling_ignored_during_execution' => :'Array<K8sIoApiCoreV1PodAffinityTerm>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



103
104
105
106
107
108
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      preferred_during_scheduling_ignored_during_execution == o.preferred_during_scheduling_ignored_during_execution &&
      required_during_scheduling_ignored_during_execution == o.required_during_scheduling_ignored_during_execution
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


112
113
114
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 112

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



118
119
120
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 118

def hash
  [preferred_during_scheduling_ignored_during_execution, required_during_scheduling_ignored_during_execution].hash
end

#list_invalid_propertiesObject

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



88
89
90
91
92
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 88

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hashHash

Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 147

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

    hash[param] = _to_hash(value)
  end
  hash
end

#valid?Boolean

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



96
97
98
99
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_anti_affinity.rb', line 96

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end