Class V1Probe

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

Inheritance

object

V1Probe

Implements

IEquatable<V1Probe>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: k8s.Models

Assembly: KubernetesClient.dll

Syntax

public record V1Probe : IEquatable<V1Probe>

Constructors

V1Probe()

Declaration

public V1Probe()

V1Probe(V1Probe)

Declaration

protected V1Probe(V1Probe original)

Parameters

Type	Name	Description
V1Probe	original

Properties

EqualityContract

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

Exec

Exec specifies a command to execute in the container.

Declaration

[JsonPropertyName("exec")]
public V1ExecAction Exec { get; set; }

Property Value

Type	Description
V1ExecAction

FailureThreshold

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

Declaration

[JsonPropertyName("failureThreshold")]
public int? FailureThreshold { get; set; }

Property Value

Type	Description
int?

Grpc

GRPC specifies a GRPC HealthCheckRequest.

Declaration

[JsonPropertyName("grpc")]
public V1GRPCAction Grpc { get; set; }

Property Value

Type	Description
V1GRPCAction

HttpGet

HTTPGet specifies an HTTP GET request to perform.

Declaration

[JsonPropertyName("httpGet")]
public V1HTTPGetAction HttpGet { get; set; }

Property Value

Type	Description
V1HTTPGetAction

InitialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Declaration

[JsonPropertyName("initialDelaySeconds")]
public 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.

Declaration

[JsonPropertyName("periodSeconds")]
public int? PeriodSeconds { get; set; }

Property Value

Type	Description
int?

SuccessThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

Declaration

[JsonPropertyName("successThreshold")]
public int? SuccessThreshold { get; set; }

Property Value

Type	Description
int?

TcpSocket

TCPSocket specifies a connection to a TCP port.

Declaration

[JsonPropertyName("tcpSocket")]
public V1TCPSocketAction TcpSocket { get; set; }

Property Value

Type	Description
V1TCPSocketAction

TerminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

Declaration

[JsonPropertyName("terminationGracePeriodSeconds")]
public long? TerminationGracePeriodSeconds { get; set; }

Property Value

Type	Description
long?

TimeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Declaration

[JsonPropertyName("timeoutSeconds")]
public int? TimeoutSeconds { get; set; }

Property Value

Type	Description
int?

Methods

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

Equals(V1Probe?)

Declaration

public virtual bool Equals(V1Probe? other)

Parameters

Type	Name	Description
V1Probe	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Operators

operator ==(V1Probe?, V1Probe?)

Declaration

public static bool operator ==(V1Probe? left, V1Probe? right)

Parameters

Type	Name	Description
V1Probe	left
V1Probe	right

Returns

Type	Description
bool

operator !=(V1Probe?, V1Probe?)

Declaration

public static bool operator !=(V1Probe? left, V1Probe? right)

Parameters

Type	Name	Description
V1Probe	left
V1Probe	right

Returns

Type	Description
bool

Implements

IEquatable<T>