Class: Kubevirt::V1Probe

Inherits:
ApiModelBase show all
Defined in:
lib/kubevirt/models/v1_probe.rb

Overview

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

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 = {}) ⇒ V1Probe

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/kubevirt/models/v1_probe.rb', line 91

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#exec ⇒ Object

Returns the value of attribute exec.



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

def failure_threshold
  @failure_threshold
end

#guest_agent_ping ⇒ Object

GuestAgentPing configures the guest-agent based ping probe



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

def guest_agent_ping
  @guest_agent_ping
end

#http_get ⇒ Object

Returns the value of attribute http_get.



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

def http_get
  @http_get
end

#initial_delay_seconds ⇒ Object

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



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

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.



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

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.



36
37
38
 
# File 'lib/kubevirt/models/v1_probe.rb', line 36

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Object

Returns the value of attribute tcp_socket.



38
39
40
 
# File 'lib/kubevirt/models/v1_probe.rb', line 38

def tcp_socket
  @tcp_socket
end

#timeout_seconds ⇒ Object

Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



41
42
43
 
# File 'lib/kubevirt/models/v1_probe.rb', line 41

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/kubevirt/models/v1_probe.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/kubevirt/models/v1_probe.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'exec' => :'exec',
    :'failure_threshold' => :'failureThreshold',
    :'guest_agent_ping' => :'guestAgentPing',
    :'http_get' => :'httpGet',
    :'initial_delay_seconds' => :'initialDelaySeconds',
    :'period_seconds' => :'periodSeconds',
    :'success_threshold' => :'successThreshold',
    :'tcp_socket' => :'tcpSocket',
    :'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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/kubevirt/models/v1_probe.rb', line 188

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



84
85
86
87
 
# File 'lib/kubevirt/models/v1_probe.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/kubevirt/models/v1_probe.rb', line 69

def self.openapi_types
  {
    :'exec' => :'K8sIoApiCoreV1ExecAction',
    :'failure_threshold' => :'Integer',
    :'guest_agent_ping' => :'Object',
    :'http_get' => :'K8sIoApiCoreV1HTTPGetAction',
    :'initial_delay_seconds' => :'Integer',
    :'period_seconds' => :'Integer',
    :'success_threshold' => :'Integer',
    :'tcp_socket' => :'K8sIoApiCoreV1TCPSocketAction',
    :'timeout_seconds' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/kubevirt/models/v1_probe.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      exec == o.exec &&
      failure_threshold == o.failure_threshold &&
      guest_agent_ping == o.guest_agent_ping &&
      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 &&
      timeout_seconds == o.timeout_seconds
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/kubevirt/models/v1_probe.rb', line 181

def hash
  [exec, failure_threshold, guest_agent_ping, 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?

Returns:

  • Array for valid properties with the reasons



144
145
146
147
148
 
# File 'lib/kubevirt/models/v1_probe.rb', line 144

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/kubevirt/models/v1_probe.rb', line 210

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



152
153
154
155
 
# File 'lib/kubevirt/models/v1_probe.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end