Class: Kubernetes::V1PodAffinity

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_pod_affinity.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1PodAffinity

Initializes the object



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 42

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 }

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

  return unless attributes.key?(:requiredDuringSchedulingIgnoredDuringExecution) && (value = attributes[:requiredDuringSchedulingIgnoredDuringExecution]).is_a?(Array)

  self.required_during_scheduling_ignored_during_execution = value
end

Instance Attribute Details

#preferred_during_scheduling_ignored_during_execution ⇒ Object

The scheduler will prefer to schedule pods to nodes that satisfy the 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 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.



19
20
21
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 19

def preferred_during_scheduling_ignored_during_execution
  @preferred_during_scheduling_ignored_during_execution
end

#required_during_scheduling_ignored_during_execution ⇒ Object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the 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.



22
23
24
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 22

def required_during_scheduling_ignored_during_execution
  @required_during_scheduling_ignored_during_execution
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 25

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

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 33

def self.swagger_types
  {
    preferred_during_scheduling_ignored_during_execution: :'Array<V1WeightedPodAffinityTerm>',
    required_during_scheduling_ignored_during_execution: :'Array<V1PodAffinityTerm>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



71
72
73
74
75
76
77
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 71

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

  self.class == other.class &&
    preferred_during_scheduling_ignored_during_execution == other.preferred_during_scheduling_ignored_during_execution &&
    required_during_scheduling_ignored_during_execution == other.required_during_scheduling_ignored_during_execution
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



120
121
122
123
124
125
126
127
128
129
130
131
132
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/kubernetes/models/v1_pod_affinity.rb', line 120

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Kubernetes.const_get(type).new
    temp_model.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



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 187

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 95

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
          _deserialize(Regexp.last_match(1), v)
        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(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

See Also:

  • `==` method


81
82
83
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 81

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



87
88
89
90
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 87

def hash
  [preferred_during_scheduling_ignored_during_execution,
   required_during_scheduling_ignored_during_execution].hash
end

#list_invalid_properties ⇒ Object

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



59
60
61
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 59

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



166
167
168
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 166

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 172

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

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

#to_s ⇒ String

Returns the string representation of the object



160
161
162
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 160

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



65
66
67
 
# File 'lib/kubernetes/models/v1_pod_affinity.rb', line 65

def valid?
  true
end