Vertex AI v1 API - Class Probe (3.18.0)

Version 3.18.0

• 3.19.0 (latest)
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class Probe : IMessage<Probe>, IEquatable<Probe>, IDeepCloneable<Probe>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1 API class Probe.

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

Inheritance

object > Probe

Implements

IMessageProbe, IEquatableProbe, IDeepCloneableProbe, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Probe()

public Probe()

Probe(Probe)

public Probe(Probe other)

Parameter
Name	Description
other	Probe

Properties

Exec

public Probe.Types.ExecAction Exec { get; set; }

ExecAction probes the health of a container by executing a command.

Property Value
Type	Description
ProbeTypesExecAction

FailureThreshold

public int FailureThreshold { get; set; }

Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

Maps to Kubernetes probe argument 'failureThreshold'.

Property Value
Type	Description
int

Grpc

public Probe.Types.GrpcAction Grpc { get; set; }

GrpcAction probes the health of a container by sending a gRPC request.

Property Value
Type	Description
ProbeTypesGrpcAction

HttpGet

public Probe.Types.HttpGetAction HttpGet { get; set; }

HttpGetAction probes the health of a container by sending an HTTP GET request.

Property Value
Type	Description
ProbeTypesHttpGetAction

InitialDelaySeconds

public int InitialDelaySeconds { get; set; }

Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

Maps to Kubernetes probe argument 'initialDelaySeconds'.

Property Value
Type	Description
int

PeriodSeconds

public int PeriodSeconds { get; set; }

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'.

Property Value
Type	Description
int

ProbeTypeCase

public Probe.ProbeTypeOneofCase ProbeTypeCase { get; }

Property Value
Type	Description
ProbeProbeTypeOneofCase

SuccessThreshold

public int SuccessThreshold { get; set; }

Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

Maps to Kubernetes probe argument 'successThreshold'.

Property Value
Type	Description
int

TcpSocket

public Probe.Types.TcpSocketAction TcpSocket { get; set; }

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

Property Value
Type	Description
ProbeTypesTcpSocketAction

TimeoutSeconds

public int TimeoutSeconds { get; set; }

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'.

Property Value
Type	Description
int