Show / Hide Table of Contents

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
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudRun.v1.Data
Assembly: Google.Apis.CloudRun.v1.dll
Syntax
public class Probe : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Exec

Not supported by Cloud Run.

Declaration
[JsonProperty("exec")]
public virtual ExecAction Exec { get; set; }
Property Value
Type Description
ExecAction

FailureThreshold

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

Declaration
[JsonProperty("failureThreshold")]
public virtual int? FailureThreshold { get; set; }
Property Value
Type Description
int?

Grpc

GRPCAction specifies an action involving a GRPC port.

Declaration
[JsonProperty("grpc")]
public virtual GRPCAction Grpc { get; set; }
Property Value
Type Description
GRPCAction

HttpGet

HTTPGet specifies the http request to perform.

Declaration
[JsonProperty("httpGet")]
public virtual HTTPGetAction HttpGet { get; set; }
Property Value
Type Description
HTTPGetAction

InitialDelaySeconds

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.

Declaration
[JsonProperty("initialDelaySeconds")]
public virtual int? InitialDelaySeconds { get; set; }
Property Value
Type Description
int?

PeriodSeconds

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.

Declaration
[JsonProperty("periodSeconds")]
public virtual int? PeriodSeconds { get; set; }
Property Value
Type Description
int?

SuccessThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Declaration
[JsonProperty("successThreshold")]
public virtual int? SuccessThreshold { get; set; }
Property Value
Type Description
int?

TcpSocket

TCPSocket specifies an action involving a TCP port.

Declaration
[JsonProperty("tcpSocket")]
public virtual TCPSocketAction TcpSocket { get; set; }
Property Value
Type Description
TCPSocketAction

TimeoutSeconds

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; if period_seconds is not set, must be less or equal than 10.

Declaration
[JsonProperty("timeoutSeconds")]
public virtual int? TimeoutSeconds { get; set; }
Property Value
Type Description
int?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX