Class: Kubernetes::V1Probe

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/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 = {}) ⇒ V1Probe

Initializes the object



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/kubernetes/models/v1_probe.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

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

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

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

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

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

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

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

  return unless attributes.key?(:timeoutSeconds)

  self.timeout_seconds = attributes[:timeoutSeconds]
end

Instance Attribute Details

#exec ⇒ Object

One and only one of the following should be specified. Exec specifies the action to take.



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

def failure_threshold
  @failure_threshold
end

#http_get ⇒ Object

HTTPGet specifies the http request to perform.



25
26
27
 
# File 'lib/kubernetes/models/v1_probe.rb', line 25

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



28
29
30
 
# File 'lib/kubernetes/models/v1_probe.rb', line 28

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.



31
32
33
 
# File 'lib/kubernetes/models/v1_probe.rb', line 31

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. Minimum value is 1.



34
35
36
 
# File 'lib/kubernetes/models/v1_probe.rb', line 34

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported



37
38
39
 
# File 'lib/kubernetes/models/v1_probe.rb', line 37

def tcp_socket
  @tcp_socket
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



40
41
42
 
# File 'lib/kubernetes/models/v1_probe.rb', line 40

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/kubernetes/models/v1_probe.rb', line 43

def self.attribute_map
  {
    exec: :exec,
    failure_threshold: :failureThreshold,
    http_get: :httpGet,
    initial_delay_seconds: :initialDelaySeconds,
    period_seconds: :periodSeconds,
    success_threshold: :successThreshold,
    tcp_socket: :tcpSocket,
    timeout_seconds: :timeoutSeconds
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/kubernetes/models/v1_probe.rb', line 57

def self.swagger_types
  {
    exec: :V1ExecAction,
    failure_threshold: :Integer,
    http_get: :V1HTTPGetAction,
    initial_delay_seconds: :Integer,
    period_seconds: :Integer,
    success_threshold: :Integer,
    tcp_socket: :V1TCPSocketAction,
    timeout_seconds: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/kubernetes/models/v1_probe.rb', line 113

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

  self.class == other.class &&
    exec == other.exec &&
    failure_threshold == other.failure_threshold &&
    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 &&
    timeout_seconds == other.timeout_seconds
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
203
 
# File 'lib/kubernetes/models/v1_probe.rb', line 167

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/kubernetes/models/v1_probe.rb', line 234

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/kubernetes/models/v1_probe.rb', line 143

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

See Also:

  • `==` method


129
130
131
 
# File 'lib/kubernetes/models/v1_probe.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



135
136
137
138
 
# File 'lib/kubernetes/models/v1_probe.rb', line 135

def hash
  [exec, failure_threshold, http_get, initial_delay_seconds, period_seconds, success_threshold,
   tcp_socket, timeout_seconds].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



101
102
103
 
# File 'lib/kubernetes/models/v1_probe.rb', line 101

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



213
214
215
 
# File 'lib/kubernetes/models/v1_probe.rb', line 213

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/kubernetes/models/v1_probe.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



207
208
209
 
# File 'lib/kubernetes/models/v1_probe.rb', line 207

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



107
108
109
 
# File 'lib/kubernetes/models/v1_probe.rb', line 107

def valid?
  true
end