Cloud Run Admin v2 API - Class Probe (2.2.0)

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

Reference documentation and code samples for the Cloud Run Admin v2 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

IMessage Probe, IEquatable Probe, IDeepCloneable Probe, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

Probe()

public Probe()

Probe(Probe)

public Probe(Probe other)

Parameter
Name	Description
`other`	`Probe`

Properties

FailureThreshold

public int FailureThreshold { get; set; }

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Property Value
Type	Description
`int`

Grpc

public GRPCAction Grpc { get; set; }

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Property Value
Type	Description
`GRPCAction`

HttpGet

public HTTPGetAction HttpGet { get; set; }

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Property Value
Type	Description
`HTTPGetAction`

InitialDelaySeconds

public int InitialDelaySeconds { get; set; }

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

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. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

Property Value
Type	Description
`int`

ProbeTypeCase

public Probe.ProbeTypeOneofCase ProbeTypeCase { get; }

Property Value
Type	Description
`ProbeProbeTypeOneofCase`

TcpSocket

public TCPSocketAction TcpSocket { get; set; }

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Property Value
Type	Description
`TCPSocketAction`

TimeoutSeconds

public int TimeoutSeconds { get; set; }

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.

Property Value
Type	Description
`int`