Class: Kubevirt::K8sIoApiCoreV1PodAffinityTerm

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/k8s_io_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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ K8sIoApiCoreV1PodAffinityTerm

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 77

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::K8sIoApiCoreV1PodAffinityTerm` 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::K8sIoApiCoreV1PodAffinityTerm`. 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?(:'label_selector')
    self.label_selector = attributes[:'label_selector']
  end

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

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

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

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

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

Instance Attribute Details

#label_selector ⇒ Object

Returns the value of attribute label_selector.



19
20
21
 
# File 'lib/kubevirt/models/k8s_io_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.



22
23
24
 
# File 'lib/kubevirt/models/k8s_io_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.



25
26
27
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 25

def mismatch_label_keys
  @mismatch_label_keys
end

#namespace_selector ⇒ Object

Returns the value of attribute namespace_selector.



27
28
29
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 27

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



30
31
32
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 30

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.



33
34
35
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 33

def topology_key
  @topology_key
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



48
49
50
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 48

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 36

def self.attribute_map
  {
    :'label_selector' => :'labelSelector',
    :'match_label_keys' => :'matchLabelKeys',
    :'mismatch_label_keys' => :'mismatchLabelKeys',
    :'namespace_selector' => :'namespaceSelector',
    :'namespaces' => :'namespaces',
    :'topology_key' => :'topologyKey'
  }
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 182

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_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 58

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 156

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 175

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



126
127
128
129
130
131
132
133
134
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 126

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 204

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

Returns:

  • (Boolean) —

    true if the model is valid



138
139
140
141
142
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_pod_affinity_term.rb', line 138

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @topology_key.nil?
  true
end