Class: ArgoWorkflows::IoK8sApiCoreV1PodAffinityTerm

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb

Overview

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1PodAffinityTerm

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 62

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.has_key?(:'labelSelector')
    self.label_selector = attributes[:'labelSelector']
  end

  if attributes.has_key?(:'matchLabelKeys')
    if (value = attributes[:'matchLabelKeys']).is_a?(Array)
      self.match_label_keys = value
    end
  end

  if attributes.has_key?(:'mismatchLabelKeys')
    if (value = attributes[:'mismatchLabelKeys']).is_a?(Array)
      self.mismatch_label_keys = value
    end
  end

  if attributes.has_key?(:'namespaceSelector')
    self.namespace_selector = attributes[:'namespaceSelector']
  end

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

  if attributes.has_key?(:'topologyKey')
    self.topology_key = attributes[:'topologyKey']
  end
end

Instance Attribute Details

#label_selector ⇒ Object

A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.



19
20
21
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 19

def label_selector
  @label_selector
end

#match_label_keys ⇒ Object

MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with ‘labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).



22
23
24
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 22

def match_label_keys
  @match_label_keys
end

#mismatch_label_keys ⇒ Object

MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with ‘labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).



25
26
27
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 25

def mismatch_label_keys
  @mismatch_label_keys
end

#namespace_selector ⇒ Object

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod’s namespace". An empty selector ({}) matches all namespaces.



28
29
30
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 28

def namespace_selector
  @namespace_selector
end

#namespaces ⇒ Object

namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod’s namespace".



31
32
33
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 31

def namespaces
  @namespaces
end

#topology_key ⇒ Object

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.



34
35
36
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 34

def topology_key
  @topology_key
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 37

def self.attribute_map
  {
    :'label_selector' => :'labelSelector',
    :'match_label_keys' => :'matchLabelKeys',
    :'mismatch_label_keys' => :'mismatchLabelKeys',
    :'namespace_selector' => :'namespaceSelector',
    :'namespaces' => :'namespaces',
    :'topology_key' => :'topologyKey'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 49

def self.swagger_types
  {
    :'label_selector' => :'IoK8sApimachineryPkgApisMetaV1LabelSelector',
    :'match_label_keys' => :'Array<String>',
    :'mismatch_label_keys' => :'Array<String>',
    :'namespace_selector' => :'IoK8sApimachineryPkgApisMetaV1LabelSelector',
    :'namespaces' => :'Array<String>',
    :'topology_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label_selector == o.label_selector &&
      match_label_keys == o.match_label_keys &&
      mismatch_label_keys == o.mismatch_label_keys &&
      namespace_selector == o.namespace_selector &&
      namespaces == o.namespaces &&
      topology_key == o.topology_key
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



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
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 166

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 232

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 145

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 attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



138
139
140
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 138

def hash
  [label_selector, match_label_keys, mismatch_label_keys, namespace_selector, namespaces, topology_key].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



101
102
103
104
105
106
107
108
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  if @topology_key.nil?
    invalid_properties.push('invalid value for "topology_key", topology_key cannot be nil.')
  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



212
213
214
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 212

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



218
219
220
221
222
223
224
225
226
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 218

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



206
207
208
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 206

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



112
113
114
115
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_affinity_term.rb', line 112

def valid?
  return false if @topology_key.nil?
  true
end