Package io.kubernetes.client.openapi.models

Class V1PersistentVolumeClaimStatus

java.lang.Object
io.kubernetes.client.openapi.models.V1PersistentVolumeClaimStatus
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-02-04T19:05:53.712211Z[Etc/UTC]", comments="Generator version: 7.6.0") public class V1PersistentVolumeClaimStatus extends Object
PersistentVolumeClaimStatus is the current status of a persistent volume claim.

  • Field Details

  • Constructor Details

    • V1PersistentVolumeClaimStatus

      public V1PersistentVolumeClaimStatus()

  • Method Details

    • accessModes

      public V1PersistentVolumeClaimStatus accessModes(List<String> accessModes)

    • addAccessModesItem

      public V1PersistentVolumeClaimStatus addAccessModesItem(String accessModesItem)

    • getAccessModes

      @Nullable public List<String> getAccessModes()
      accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
      Returns:
      accessModes

    • setAccessModes

      public void setAccessModes(List<String> accessModes)

    • allocatedResourceStatuses

      public V1PersistentVolumeClaimStatus allocatedResourceStatuses(Map<String,String> allocatedResourceStatuses)

    • putAllocatedResourceStatusesItem

      public V1PersistentVolumeClaimStatus putAllocatedResourceStatusesItem(String key, String allocatedResourceStatusesItem)

    • getAllocatedResourceStatuses

      @Nullable public Map<String,String> getAllocatedResourceStatuses()
      allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeInProgress\" - pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeFailed\" - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizePending\" - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeInProgress\" - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeFailed\" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
      Returns:
      allocatedResourceStatuses

    • setAllocatedResourceStatuses

      public void setAllocatedResourceStatuses(Map<String,String> allocatedResourceStatuses)

    • allocatedResources

      public V1PersistentVolumeClaimStatus allocatedResources(Map<String,Quantity> allocatedResources)

    • putAllocatedResourcesItem

      public V1PersistentVolumeClaimStatus putAllocatedResourcesItem(String key, Quantity allocatedResourcesItem)

    • getAllocatedResources

      @Nullable public Map<String,Quantity> getAllocatedResources()
      allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
      Returns:
      allocatedResources

    • setAllocatedResources

      public void setAllocatedResources(Map<String,Quantity> allocatedResources)

    • capacity

      public V1PersistentVolumeClaimStatus capacity(Map<String,Quantity> capacity)

    • putCapacityItem

      public V1PersistentVolumeClaimStatus putCapacityItem(String key, Quantity capacityItem)

    • getCapacity

      @Nullable public Map<String,Quantity> getCapacity()
      capacity represents the actual resources of the underlying volume.
      Returns:
      capacity

    • setCapacity

      public void setCapacity(Map<String,Quantity> capacity)

    • conditions

      public V1PersistentVolumeClaimStatus conditions(List<V1PersistentVolumeClaimCondition> conditions)

    • addConditionsItem

      public V1PersistentVolumeClaimStatus addConditionsItem(V1PersistentVolumeClaimCondition conditionsItem)

    • getConditions

      @Nullable public List<V1PersistentVolumeClaimCondition> getConditions()
      conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
      Returns:
      conditions

    • setConditions

      public void setConditions(List<V1PersistentVolumeClaimCondition> conditions)

    • currentVolumeAttributesClassName

      public V1PersistentVolumeClaimStatus currentVolumeAttributesClassName(String currentVolumeAttributesClassName)

    • getCurrentVolumeAttributesClassName

      @Nullable public String getCurrentVolumeAttributesClassName()
      currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
      Returns:
      currentVolumeAttributesClassName

    • setCurrentVolumeAttributesClassName

      public void setCurrentVolumeAttributesClassName(String currentVolumeAttributesClassName)

    • modifyVolumeStatus

      public V1PersistentVolumeClaimStatus modifyVolumeStatus(V1ModifyVolumeStatus modifyVolumeStatus)

    • getModifyVolumeStatus

      @Nullable public V1ModifyVolumeStatus getModifyVolumeStatus()
      Get modifyVolumeStatus
      Returns:
      modifyVolumeStatus

    • setModifyVolumeStatus

      public void setModifyVolumeStatus(V1ModifyVolumeStatus modifyVolumeStatus)

    • phase

      public V1PersistentVolumeClaimStatus phase(String phase)

    • getPhase

      @Nullable public String getPhase()
      phase represents the current phase of PersistentVolumeClaim.
      Returns:
      phase

    • setPhase

      public void setPhase(String phase)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to V1PersistentVolumeClaimStatus

    • fromJson

      public static V1PersistentVolumeClaimStatus fromJson(String jsonString) throws IOException
      Create an instance of V1PersistentVolumeClaimStatus given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of V1PersistentVolumeClaimStatus
      Throws:
      IOException - if the JSON string is invalid with respect to V1PersistentVolumeClaimStatus

    • toJson

      public String toJson()
      Convert an instance of V1PersistentVolumeClaimStatus to an JSON string
      Returns:
      JSON string