Class: Zilla::IoK8sApiBatchV1PodFailurePolicyOnExitCodesRequirement

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb

Overview

PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiBatchV1PodFailurePolicyOnExitCodesRequirement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiBatchV1PodFailurePolicyOnExitCodesRequirement` initialize method'
  end

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

    h[k.to_sym] = v
  end

  self.container_name = attributes[:container_name] if attributes.key?(:container_name)

  self.operator = attributes[:operator] if attributes.key?(:operator)

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

  self.values = value
end

Instance Attribute Details

#container_name ⇒ Object

Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.



20
21
22
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 20

def container_name
  @container_name
end

#operator ⇒ Object

Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.



23
24
25
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 23

def operator
  @operator
end

#values ⇒ Object

Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value ‘0’ cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.



26
27
28
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 26

def values
  @values
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 38

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 29

def self.attribute_map
  {
    container_name: :containerName,
    operator: :operator,
    values: :values
  }
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



130
131
132
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 130

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



52
53
54
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 52

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 43

def self.openapi_types
  {
    container_name: :String,
    operator: :String,
    values: :'Array<Integer>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
110
111
112
113
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 106

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

  self.class == other.class &&
    container_name == other.container_name &&
    operator == other.operator &&
    values == other.values
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



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
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 164

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 235

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 137

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

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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[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
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



123
124
125
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 123

def hash
  [container_name, operator, values].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



86
87
88
89
90
91
92
93
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 86

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "operator", operator cannot be nil.') if @operator.nil?

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

  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



211
212
213
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 211

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 217

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



205
206
207
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 205

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



97
98
99
100
101
102
 
# File 'lib/zilla/models/io_k8s_api_batch_v1_pod_failure_policy_on_exit_codes_requirement.rb', line 97

def valid?
  return false if @operator.nil?
  return false if @values.nil?

  true
end