Class: Google::Apis::RunV1alpha1::Probe
- Inherits:
-
Object
- Object
- Google::Apis::RunV1alpha1::Probe
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/run_v1alpha1/classes.rb,
generated/google/apis/run_v1alpha1/representations.rb,
generated/google/apis/run_v1alpha1/representations.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
-
#failure_threshold ⇒ Fixnum
Minimum consecutive failures for the probe to be considered failed after having succeeded.
-
#handler ⇒ Google::Apis::RunV1alpha1::Handler
Handler defines a specific action that should be taken Corresponds to the JSON property
handler
. -
#initial_delay_seconds ⇒ Fixnum
Number of seconds after the container has started before liveness probes are initiated.
-
#period_seconds ⇒ Fixnum
How often (in seconds) to perform the probe.
-
#success_threshold ⇒ Fixnum
Minimum consecutive successes for the probe to be considered successful after having failed.
-
#timeout_seconds ⇒ Fixnum
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
2094 2095 2096 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2094 def initialize(**args) update!(**args) end |
Instance Attribute Details
#failure_threshold ⇒ Fixnum
Minimum consecutive failures for the probe to be considered failed after
having succeeded. Defaults to 3. Minimum value is 1. +optional
Corresponds to the JSON property failureThreshold
2054 2055 2056 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2054 def failure_threshold @failure_threshold end |
#handler ⇒ Google::Apis::RunV1alpha1::Handler
Handler defines a specific action that should be taken
Corresponds to the JSON property handler
2059 2060 2061 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2059 def handler @handler end |
#initial_delay_seconds ⇒ Fixnum
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
+optional
Corresponds to the JSON property initialDelaySeconds
2068 2069 2070 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2068 def initial_delay_seconds @initial_delay_seconds end |
#period_seconds ⇒ Fixnum
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
+optional
Corresponds to the JSON property periodSeconds
2075 2076 2077 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2075 def period_seconds @period_seconds end |
#success_threshold ⇒ Fixnum
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. +optional
Corresponds to the JSON property successThreshold
2082 2083 2084 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2082 def success_threshold @success_threshold end |
#timeout_seconds ⇒ Fixnum
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
+optional
Corresponds to the JSON property timeoutSeconds
2092 2093 2094 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2092 def timeout_seconds @timeout_seconds end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2099 2100 2101 2102 2103 2104 2105 2106 |
# File 'generated/google/apis/run_v1alpha1/classes.rb', line 2099 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 |