Class: Zilla::IoK8sApiCoreV1Probe

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

Overview

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1Probe

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/zilla/models/io_k8s_api_core_v1_probe.rb', line 83

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiCoreV1Probe` 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::IoK8sApiCoreV1Probe`. 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.exec = attributes[:exec] if attributes.key?(:exec)

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

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

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

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

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

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

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

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

  return unless attributes.key?(:timeout_seconds)

  self.timeout_seconds = attributes[:timeout_seconds]
end

Instance Attribute Details

#exec ⇒ Object

Returns the value of attribute exec.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 19

def exec
  @exec
end

#failure_threshold ⇒ Object

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.



22
23
24
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 22

def failure_threshold
  @failure_threshold
end

#grpc ⇒ Object

Returns the value of attribute grpc.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 19

def grpc
  @grpc
end

#http_get ⇒ Object

Returns the value of attribute http_get.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 19

def http_get
  @http_get
end

#initial_delay_seconds ⇒ Object

Number of seconds after the container has started before liveness probes are initiated. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



25
26
27
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 25

def initial_delay_seconds
  @initial_delay_seconds
end

#period_seconds ⇒ Object

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.



28
29
30
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 28

def period_seconds
  @period_seconds
end

#success_threshold ⇒ Object

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.



31
32
33
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 31

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Object

Returns the value of attribute tcp_socket.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 19

def tcp_socket
  @tcp_socket
end

#termination_grace_period_seconds ⇒ Object

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 34

def termination_grace_period_seconds
  @termination_grace_period_seconds
end

#timeout_seconds ⇒ Object

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



37
38
39
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 37

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 40

def self.attribute_map
  {
    exec: :exec,
    failure_threshold: :failureThreshold,
    grpc: :grpc,
    http_get: :httpGet,
    initial_delay_seconds: :initialDelaySeconds,
    period_seconds: :periodSeconds,
    success_threshold: :successThreshold,
    tcp_socket: :tcpSocket,
    termination_grace_period_seconds: :terminationGracePeriodSeconds,
    timeout_seconds: :timeoutSeconds
  }
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



170
171
172
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 170

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 61

def self.openapi_types
  {
    exec: :IoK8sApiCoreV1ExecAction,
    failure_threshold: :Integer,
    grpc: :IoK8sApiCoreV1GRPCAction,
    http_get: :IoK8sApiCoreV1HTTPGetAction,
    initial_delay_seconds: :Integer,
    period_seconds: :Integer,
    success_threshold: :Integer,
    tcp_socket: :IoK8sApiCoreV1TCPSocketAction,
    termination_grace_period_seconds: :Integer,
    timeout_seconds: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 138

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

  self.class == other.class &&
    exec == other.exec &&
    failure_threshold == other.failure_threshold &&
    grpc == other.grpc &&
    http_get == other.http_get &&
    initial_delay_seconds == other.initial_delay_seconds &&
    period_seconds == other.period_seconds &&
    success_threshold == other.success_threshold &&
    tcp_socket == other.tcp_socket &&
    termination_grace_period_seconds == other.termination_grace_period_seconds &&
    timeout_seconds == other.timeout_seconds
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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 204

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 275

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 177

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


156
157
158
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
165
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 162

def hash
  [exec, failure_threshold, grpc, http_get, initial_delay_seconds, period_seconds, success_threshold, tcp_socket,
   termination_grace_period_seconds, timeout_seconds].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
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 126

def list_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



251
252
253
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 251

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 257

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



245
246
247
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 245

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



132
133
134
 
# File 'lib/zilla/models/io_k8s_api_core_v1_probe.rb', line 132

def valid?
  true
end