Class Probe (1.89.0)

Version latest

• 1.89.0 (latest)
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

Probe(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
exec_	google.cloud.aiplatform_v1.types.Probe.ExecAction ExecAction probes the health of a container by executing a command. This field is a member of oneof_ probe_type.
http_get	google.cloud.aiplatform_v1.types.Probe.HttpGetAction HttpGetAction probes the health of a container by sending an HTTP GET request. This field is a member of oneof_ probe_type.
grpc	google.cloud.aiplatform_v1.types.Probe.GrpcAction GrpcAction probes the health of a container by sending a gRPC request. This field is a member of oneof_ probe_type.
tcp_socket	google.cloud.aiplatform_v1.types.Probe.TcpSocketAction TcpSocketAction probes the health of a container by opening a TCP socket connection. This field is a member of oneof_ probe_type.
period_seconds	int How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
timeout_seconds	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. Maps to Kubernetes probe argument 'timeoutSeconds'.
failure_threshold	int Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
success_threshold	int Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
initial_delay_seconds	int Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.

Classes

ExecAction

ExecAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

ExecAction specifies a command to execute.

GrpcAction

GrpcAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

GrpcAction checks the health of a container using a gRPC service.

HttpGetAction

HttpGetAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

HttpGetAction describes an action based on HTTP Get requests.

HttpHeader

HttpHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)

HttpHeader describes a custom header to be used in HTTP probes

TcpSocketAction

TcpSocketAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

TcpSocketAction probes the health of a container by opening a TCP socket connection.

Methods

Probe

Probe(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields