Struct PersistentVolumeClaimStatus 

pub struct PersistentVolumeClaimStatus {
    pub phase: Option<String>,
    pub access_modes: Vec<String>,
    pub capacity: BTreeMap<String, Quantity>,
    pub conditions: Vec<PersistentVolumeClaimCondition>,
    pub allocated_resources: BTreeMap<String, Quantity>,
    pub allocated_resource_statuses: BTreeMap<String, String>,
    pub current_volume_attributes_class_name: Option<String>,
    pub modify_volume_status: Option<ModifyVolumeStatus>,
}

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Fields

phase: Option<String>

phase represents the current phase of PersistentVolumeClaim. +optional

access_modes: Vec<String>

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 +optional +listType=atomic

capacity: BTreeMap<String, Quantity>

capacity represents the actual resources of the underlying volume. +optional

conditions: Vec<PersistentVolumeClaimCondition>

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to ‘Resizing’. +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type

allocated_resources: BTreeMap<String, Quantity>

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. +featureGate=RecoverVolumeExpansionFailure +optional

allocated_resource_statuses: BTreeMap<String, String>

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. +featureGate=RecoverVolumeExpansionFailure +mapType=granular +optional

current_volume_attributes_class_name: Option<String>

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). +featureGate=VolumeAttributesClass +optional

modify_volume_status: Option<ModifyVolumeStatus>

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default). +featureGate=VolumeAttributesClass +optional

Implementations

impl PersistentVolumeClaimStatus

pub fn phase(&self) -> &str

Returns the value of phase, or the default value if phase is unset.

pub fn current_volume_attributes_class_name(&self) -> &str

Returns the value of current_volume_attributes_class_name, or the default value if current_volume_attributes_class_name is unset.

Trait Implementations

impl Clone for PersistentVolumeClaimStatus

fn clone(&self) -> PersistentVolumeClaimStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PersistentVolumeClaimStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PersistentVolumeClaimStatus

fn default() -> Self

Returns the “default value” for a type.

impl Message for PersistentVolumeClaimStatus

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PersistentVolumeClaimStatus

fn eq(&self, other: &PersistentVolumeClaimStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PersistentVolumeClaimStatus