Probe class final
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
- Inheritance
-
- Object
- ProtoMessage
- Probe
Constructors
- Probe({Probe_ExecAction? exec, Probe_HttpGetAction? httpGet, Probe_GrpcAction? grpc, Probe_TcpSocketAction? tcpSocket, int periodSeconds = 0, int timeoutSeconds = 0, int failureThreshold = 0, int successThreshold = 0, int initialDelaySeconds = 0})
- Probe.fromJson(Object? j)
-
factory
Properties
- exec → Probe_ExecAction?
-
ExecAction probes the health of a container by executing a command.
final
- failureThreshold → int
-
Number of consecutive failures before the probe is considered failed.
Defaults to 3. Minimum value is 1.
final
- grpc → Probe_GrpcAction?
-
GrpcAction probes the health of a container by sending a gRPC request.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpGet → Probe_HttpGetAction?
-
HttpGetAction probes the health of a container by sending an HTTP GET
request.
final
- initialDelaySeconds → int
-
Number of seconds to wait before starting the probe. Defaults to 0.
Minimum value is 0.
final
- periodSeconds → int
-
How often (in seconds) to perform the probe. Default to 10 seconds.
Minimum value is 1. Must be less than timeout_seconds.
final
- qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- successThreshold → int
-
Number of consecutive successes before the probe is considered successful.
Defaults to 1. Minimum value is 1.
final
- tcpSocket → Probe_TcpSocketAction?
-
TcpSocketAction probes the health of a container by opening a TCP socket
connection.
final
- timeoutSeconds → int
-
Number of seconds after which the probe times out. Defaults to 1 second.
Minimum value is 1. Must be greater or equal to period_seconds.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Object -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- fullyQualifiedName → const String