Package io.fabric8.kubernetes.api.model

Class PersistentVolumeClaimStatus

    • Method Detail

      • getAccessModes

        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

      • setAccessModes

        public void setAccessModes​(List<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

      • getAllocatedResourceStatuses

        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.

      • setAllocatedResourceStatuses

        public void setAllocatedResourceStatuses​(Map<String,​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.

      • getAllocatedResources

        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.

      • setAllocatedResources

        public void setAllocatedResources​(Map<String,​Quantity> 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.

      • getCapacity

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

      • setCapacity

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

      • getConditions

        public 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 'Resizing'.

      • setConditions

        public void setConditions​(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 'Resizing'.

      • getCurrentVolumeAttributesClassName

        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).

      • setCurrentVolumeAttributesClassName

        public void setCurrentVolumeAttributesClassName​(String currentVolumeAttributesClassName)
        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).

      • getModifyVolumeStatus

        public ModifyVolumeStatus getModifyVolumeStatus()
        PersistentVolumeClaimStatus is the current status of a persistent volume claim.

      • setModifyVolumeStatus

        public void setModifyVolumeStatus​(ModifyVolumeStatus modifyVolumeStatus)
        PersistentVolumeClaimStatus is the current status of a persistent volume claim.

      • getPhase

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

      • setPhase

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

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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