Class: Google::Apis::RunV1::Probe
- Inherits:
-
Object
- Object
- Google::Apis::RunV1::Probe
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/run_v1/classes.rb,
generated/google/apis/run_v1/representations.rb,
generated/google/apis/run_v1/representations.rb
Overview
Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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
-
#failure_threshold ⇒ Fixnum
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive failures for the probe to be considered failed after having succeeded.
-
#handler ⇒ Google::Apis::RunV1::Handler
Cloud Run fully managed: not supported Cloud Run for Anthos: supported Handler defines a specific action that should be taken Corresponds to the JSON property
handler
. -
#initial_delay_seconds ⇒ Fixnum
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated.
-
#period_seconds ⇒ Fixnum
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe.
-
#success_threshold ⇒ Fixnum
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed.
-
#timeout_seconds ⇒ Fixnum
(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after which the probe times out.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Probe
constructor
A new instance of Probe.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Probe
Returns a new instance of Probe.
2244 2245 2246 |
# File 'generated/google/apis/run_v1/classes.rb', line 2244 def initialize(**args) update!(**args) end |
Instance Attribute Details
#failure_threshold ⇒ Fixnum
(Optional)
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
Minimum consecutive failures for the probe to be considered failed after
having succeeded. Defaults to 3. Minimum value is 1.
Corresponds to the JSON property failureThreshold
2193 2194 2195 |
# File 'generated/google/apis/run_v1/classes.rb', line 2193 def failure_threshold @failure_threshold end |
#handler ⇒ Google::Apis::RunV1::Handler
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
Handler defines a specific action that should be taken
Corresponds to the JSON property handler
2200 2201 2202 |
# File 'generated/google/apis/run_v1/classes.rb', line 2200 def handler @handler end |
#initial_delay_seconds ⇒ Fixnum
(Optional)
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
Number of seconds after the container has started before liveness probes
are initiated. More info:
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-
probes
Corresponds to the JSON property initialDelaySeconds
2211 2212 2213 |
# File 'generated/google/apis/run_v1/classes.rb', line 2211 def initial_delay_seconds @initial_delay_seconds end |
#period_seconds ⇒ Fixnum
(Optional)
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
Corresponds to the JSON property periodSeconds
2220 2221 2222 |
# File 'generated/google/apis/run_v1/classes.rb', line 2220 def period_seconds @period_seconds end |
#success_threshold ⇒ Fixnum
(Optional)
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
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.
Corresponds to the JSON property successThreshold
2230 2231 2232 |
# File 'generated/google/apis/run_v1/classes.rb', line 2230 def success_threshold @success_threshold end |
#timeout_seconds ⇒ Fixnum
(Optional)
Cloud Run fully managed: not supported
Cloud Run for Anthos: supported
Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info:
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-
probes
Corresponds to the JSON property timeoutSeconds
2242 2243 2244 |
# File 'generated/google/apis/run_v1/classes.rb', line 2242 def timeout_seconds @timeout_seconds end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2249 2250 2251 2252 2253 2254 2255 2256 |
# File 'generated/google/apis/run_v1/classes.rb', line 2249 def update!(**args) @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold) @handler = args[:handler] if args.key?(:handler) @initial_delay_seconds = args[:initial_delay_seconds] if args.key?(:initial_delay_seconds) @period_seconds = args[:period_seconds] if args.key?(:period_seconds) @success_threshold = args[:success_threshold] if args.key?(:success_threshold) @timeout_seconds = args[:timeout_seconds] if args.key?(:timeout_seconds) end |