Package io.fabric8.kubernetes.api.model

Class PodResourceClaim

java.lang.Object

io.fabric8.kubernetes.api.model.PodResourceClaim

All Implemented Interfaces:

Editable<PodResourceClaimBuilder>, KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class PodResourceClaim
extends Object
implements Editable<PodResourceClaimBuilder>, KubernetesResource

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PodResourceClaim()	No args constructor for use in serialization
PodResourceClaim(String name, String resourceClaimName, String resourceClaimTemplateName)

Method Summary

Modifier and Type	Method	Description
PodResourceClaimBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getName()	Name uniquely identifies this resource claim inside the pod.
String	getResourceClaimName()	ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.
String	getResourceClaimTemplateName()	ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setName(String name)	Name uniquely identifies this resource claim inside the pod.
void	setResourceClaimName(String resourceClaimName)	ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.
void	setResourceClaimTemplateName(String resourceClaimTemplateName)	ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod.
PodResourceClaimBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PodResourceClaim

public PodResourceClaim()

No args constructor for use in serialization

PodResourceClaim

public PodResourceClaim(String name,
                        String resourceClaimName,
                        String resourceClaimTemplateName)

Method Detail

getName

public String getName()

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

setName

public void setName(String name)

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

getResourceClaimName

public String getResourceClaimName()

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

Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.

setResourceClaimName

public void setResourceClaimName(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.

getResourceClaimTemplateName

public String getResourceClaimTemplateName()

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.

setResourceClaimTemplateName

public void setResourceClaimTemplateName(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.

edit

public PodResourceClaimBuilder edit()

Specified by:

edit in interface Editable<PodResourceClaimBuilder>

toBuilder

public PodResourceClaimBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)