Class: ArgoWorkflows::IoK8sApiCoreV1Probe

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/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



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
123
124
125
126
127
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 82

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

  if attributes.has_key?(:'failureThreshold')
    self.failure_threshold = attributes[:'failureThreshold']
  end

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

  if attributes.has_key?(:'httpGet')
    self.http_get = attributes[:'httpGet']
  end

  if attributes.has_key?(:'initialDelaySeconds')
    self.initial_delay_seconds = attributes[:'initialDelaySeconds']
  end

  if attributes.has_key?(:'periodSeconds')
    self.period_seconds = attributes[:'periodSeconds']
  end

  if attributes.has_key?(:'successThreshold')
    self.success_threshold = attributes[:'successThreshold']
  end

  if attributes.has_key?(:'tcpSocket')
    self.tcp_socket = attributes[:'tcpSocket']
  end

  if attributes.has_key?(:'terminationGracePeriodSeconds')
    self.termination_grace_period_seconds = attributes[:'terminationGracePeriodSeconds']
  end

  if attributes.has_key?(:'timeoutSeconds')
    self.timeout_seconds = attributes[:'timeoutSeconds']
  end
end

Instance Attribute Details

#exec ⇒ Object

Exec specifies the action to take.



19
20
21
 
# File 'lib/argo_workflows/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/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 22

def failure_threshold
  @failure_threshold
end

#grpc ⇒ Object

GRPC specifies an action involving a GRPC port.



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

def grpc
  @grpc
end

#http_get ⇒ Object

HTTPGet specifies the http request to perform.



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

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



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

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.



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

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.



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

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Object

TCPSocket specifies an action involving a TCP port.



40
41
42
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 40

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.



43
44
45
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 43

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



46
47
48
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 46

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 49

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

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 65

def self.swagger_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

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      exec == o.exec &&
      failure_threshold == o.failure_threshold &&
      grpc == o.grpc &&
      http_get == o.http_get &&
      initial_delay_seconds == o.initial_delay_seconds &&
      period_seconds == o.period_seconds &&
      success_threshold == o.success_threshold &&
      tcp_socket == o.tcp_socket &&
      termination_grace_period_seconds == o.termination_grace_period_seconds &&
      timeout_seconds == o.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



195
196
197
198
199
200
201
202
203
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
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 195

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 261

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 174

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


161
162
163
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 167

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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



241
242
243
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 247

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



235
236
237
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_probe.rb', line 235

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



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

def valid?
  true
end