Package com.marcnuri.yakc.model.io.k8s.api.core.v1

Class PersistentVolumeClaimStatus

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model
    public class PersistentVolumeClaimStatus
extends java.lang.Object
implements com.marcnuri.yakc.model.Model
    PersistentVolumeClaimStatus is the current status of a persistent volume claim.

    • Constructor Summary

      Constructors 
      Constructor Description
      PersistentVolumeClaimStatus()  
      PersistentVolumeClaimStatus​(java.util.List<java.lang.String> accessModes, java.util.Map<java.lang.String,​java.lang.String> allocatedResourceStatuses, java.util.Map<java.lang.String,​java.lang.String> allocatedResources, java.util.Map<java.lang.String,​java.lang.String> capacity, java.util.List<PersistentVolumeClaimCondition> conditions, java.lang.String phase)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PersistentVolumeClaimStatus.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.util.List<java.lang.String> getAccessModes()
      accessModes contains the actual access modes the volume backing the PVC has.
      java.util.Map<java.lang.String,​java.lang.String> getAllocatedResources()
      allocatedResources tracks the resources allocated to a PVC including its capacity.
      java.util.Map<java.lang.String,​java.lang.String> getAllocatedResourceStatuses()
      allocatedResourceStatuses stores status of resource being resized for the given PVC.
      java.util.Map<java.lang.String,​java.lang.String> getCapacity()
      capacity represents the actual resources of the underlying volume.
      java.util.List<PersistentVolumeClaimCondition> getConditions()
      conditions is the current Condition of persistent volume claim.
      java.lang.String getPhase()
      phase represents the current phase of PersistentVolumeClaim.
      int hashCode()  
      void setAccessModes​(java.util.List<java.lang.String> accessModes)
      accessModes contains the actual access modes the volume backing the PVC has.
      void setAllocatedResources​(java.util.Map<java.lang.String,​java.lang.String> allocatedResources)
      allocatedResources tracks the resources allocated to a PVC including its capacity.
      void setAllocatedResourceStatuses​(java.util.Map<java.lang.String,​java.lang.String> allocatedResourceStatuses)
      allocatedResourceStatuses stores status of resource being resized for the given PVC.
      void setCapacity​(java.util.Map<java.lang.String,​java.lang.String> capacity)
      capacity represents the actual resources of the underlying volume.
      void setConditions​(java.util.List<PersistentVolumeClaimCondition> conditions)
      conditions is the current Condition of persistent volume claim.
      void setPhase​(java.lang.String phase)
      phase represents the current phase of PersistentVolumeClaim.
      PersistentVolumeClaimStatus.Builder toBuilder()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PersistentVolumeClaimStatus

        public PersistentVolumeClaimStatus​(java.util.List<java.lang.String> accessModes,
                                   java.util.Map<java.lang.String,​java.lang.String> allocatedResourceStatuses,
                                   java.util.Map<java.lang.String,​java.lang.String> allocatedResources,
                                   java.util.Map<java.lang.String,​java.lang.String> capacity,
                                   java.util.List<PersistentVolumeClaimCondition> conditions,
                                   java.lang.String phase)

      • PersistentVolumeClaimStatus

        public PersistentVolumeClaimStatus()

    • Method Detail

      • getAccessModes

        public java.util.List<java.lang.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

      • getAllocatedResourceStatuses

        public java.util.Map<java.lang.String,​java.lang.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.

      • getAllocatedResources

        public java.util.Map<java.lang.String,​java.lang.String> 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.

      • getCapacity

        public java.util.Map<java.lang.String,​java.lang.String> getCapacity()
        capacity represents the actual resources of the underlying volume.

      • getConditions

        public java.util.List<PersistentVolumeClaimCondition> getConditions()
        conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

      • getPhase

        public java.lang.String getPhase()
        phase represents the current phase of PersistentVolumeClaim.

      • setAccessModes

        public void setAccessModes​(java.util.List<java.lang.String> accessModes)
        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

      • setAllocatedResourceStatuses

        public void setAllocatedResourceStatuses​(java.util.Map<java.lang.String,​java.lang.String> allocatedResourceStatuses)
        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.

      • setAllocatedResources

        public void setAllocatedResources​(java.util.Map<java.lang.String,​java.lang.String> allocatedResources)
        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.

      • setCapacity

        public void setCapacity​(java.util.Map<java.lang.String,​java.lang.String> capacity)
        capacity represents the actual resources of the underlying volume.

      • setConditions

        public void setConditions​(java.util.List<PersistentVolumeClaimCondition> conditions)
        conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

      • setPhase

        public void setPhase​(java.lang.String phase)
        phase represents the current phase of PersistentVolumeClaim.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object