Show / Hide Table of Contents

Class V1PodResourceClaim

PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.

It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.

When the DRAWorkloadResourceClaims feature gate is enabled and this Pod belongs to a PodGroup, a PodResourceClaim is matched to a PodGroupResourceClaim if all of their fields are equal (Name, ResourceClaimName, and ResourceClaimTemplateName). A matched claim references a single ResourceClaim shared across all Pods in the PodGroup, reserved for the PodGroup in ResourceClaimStatus.ReservedFor rather than for individual Pods.

Inheritance
object
V1PodResourceClaim
Implements
IEquatable<V1PodResourceClaim>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1PodResourceClaim : IEquatable<V1PodResourceClaim>

Constructors

V1PodResourceClaim()

Declaration
public V1PodResourceClaim()

V1PodResourceClaim(V1PodResourceClaim)

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

Properties

EqualityContract

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

Name

Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.

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

ResourceClaimName

ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.

Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.

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

ResourceClaimTemplateName

ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod.

The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.

When the DRAWorkloadResourceClaims feature gate is enabled and the pod belongs to a PodGroup that defines a PodGroupResourceClaim with the same Name and ResourceClaimTemplateName, this PodResourceClaim resolves to the ResourceClaim generated for the PodGroup. All pods in the group that define an equivalent PodResourceClaim matching the PodGroupResourceClaim's Name and ResourceClaimTemplateName share the same generated ResourceClaim. ResourceClaims generated for a PodGroup are owned by the PodGroup and their lifecycles are tied to the PodGroup instead of any individual pod.

This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim.

Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.

Declaration
[JsonPropertyName("resourceClaimTemplateName")]
public string ResourceClaimTemplateName { 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
object.Equals(object)

Equals(V1PodResourceClaim?)

Declaration
public virtual bool Equals(V1PodResourceClaim? other)
Parameters
Type Name Description
V1PodResourceClaim 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 ==(V1PodResourceClaim?, V1PodResourceClaim?)

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

operator !=(V1PodResourceClaim?, V1PodResourceClaim?)

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

Implements

IEquatable<T>
In this article
Back to top Generated by DocFX