Class V1ResourceHealth

ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.

Inheritance
object
V1ResourceHealth
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1ResourceHealth : IEquatable<V1ResourceHealth>

Constructors

V1ResourceHealth()

Declaration
public V1ResourceHealth()

V1ResourceHealth(V1ResourceHealth)

Declaration
protected V1ResourceHealth(V1ResourceHealth original)
Parameters
Type Name Description
V1ResourceHealth original

Properties

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type

Health

Health of the resource. can be one of:

  • Healthy: operates as normal
  • Unhealthy: reported unhealthy. We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues.
  • Unknown: The status cannot be determined. For example, Device Plugin got unregistered and hasn't been re-registered since.

In future we may want to introduce the PermanentlyUnhealthy Status.

Declaration
[JsonPropertyName("health")]
public string Health { get; set; }
Property Value
Type Description
string

Message

Message provides human-readable context for Health (e.g. "ECC error count exceeded threshold"). This field is populated by the kubelet when ResourceHealthStatusMessage is enabled if the DRA plugin returns a message, and is null otherwise.

Declaration
[JsonPropertyName("message")]
public string Message { get; set; }
Property Value
Type Description
string

ResourceID

ResourceID is the unique identifier of the resource. See the ResourceID type for more information.

Declaration
[JsonPropertyName("resourceID")]
public string ResourceID { get; set; }
Property Value
Type Description
string

Methods

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

Equals(V1ResourceHealth?)

Declaration
public virtual bool Equals(V1ResourceHealth? other)
Parameters
Type Name Description
V1ResourceHealth other
Returns
Type Description
bool

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

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

Operators

operator ==(V1ResourceHealth?, V1ResourceHealth?)

Declaration
public static bool operator ==(V1ResourceHealth? left, V1ResourceHealth? right)
Parameters
Type Name Description
V1ResourceHealth left
V1ResourceHealth right
Returns
Type Description
bool

operator !=(V1ResourceHealth?, V1ResourceHealth?)

Declaration
public static bool operator !=(V1ResourceHealth? left, V1ResourceHealth? right)
Parameters
Type Name Description
V1ResourceHealth left
V1ResourceHealth right
Returns
Type Description
bool

Implements