kubernetes_asyncio.client.models.v1_persistent_volume_claim_status module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_persistent_volume_claim_status.V1PersistentVolumeClaimStatus(access_modes=None, allocated_resource_statuses=None, allocated_resources=None, capacity=None, conditions=None, current_volume_attributes_class_name=None, modify_volume_status=None, phase=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property access_modes

Gets the access_modes of this V1PersistentVolumeClaimStatus. # noqa: E501

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 # noqa: E501

Returns:: The access_modes of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: list[str]

property allocated_resource_statuses

Gets the allocated_resource_statuses of this V1PersistentVolumeClaimStatus. # noqa: E501

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. # noqa: E501

Returns:: The allocated_resource_statuses of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: dict(str, str)

property allocated_resources

Gets the allocated_resources of this V1PersistentVolumeClaimStatus. # noqa: E501

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. # noqa: E501

Returns:: The allocated_resources of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: dict(str, str)

attribute_map = {'access_modes': 'accessModes', 'allocated_resource_statuses': 'allocatedResourceStatuses', 'allocated_resources': 'allocatedResources', 'capacity': 'capacity', 'conditions': 'conditions', 'current_volume_attributes_class_name': 'currentVolumeAttributesClassName', 'modify_volume_status': 'modifyVolumeStatus', 'phase': 'phase'}

property capacity

Gets the capacity of this V1PersistentVolumeClaimStatus. # noqa: E501

capacity represents the actual resources of the underlying volume. # noqa: E501

Returns:: The capacity of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: dict(str, str)

property conditions

Gets the conditions of this V1PersistentVolumeClaimStatus. # noqa: E501

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to ‘Resizing’. # noqa: E501

Returns:: The conditions of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: list[V1PersistentVolumeClaimCondition]

property current_volume_attributes_class_name

Gets the current_volume_attributes_class_name of this V1PersistentVolumeClaimStatus. # noqa: E501

currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim # noqa: E501

Returns:: The current_volume_attributes_class_name of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: str

property modify_volume_status

Gets the modify_volume_status of this V1PersistentVolumeClaimStatus. # noqa: E501

Returns:: The modify_volume_status of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: V1ModifyVolumeStatus

openapi_types = {'access_modes': 'list[str]', 'allocated_resource_statuses': 'dict(str, str)', 'allocated_resources': 'dict(str, str)', 'capacity': 'dict(str, str)', 'conditions': 'list[V1PersistentVolumeClaimCondition]', 'current_volume_attributes_class_name': 'str', 'modify_volume_status': 'V1ModifyVolumeStatus', 'phase': 'str'}

property phase

Gets the phase of this V1PersistentVolumeClaimStatus. # noqa: E501

phase represents the current phase of PersistentVolumeClaim. # noqa: E501

Returns:: The phase of this V1PersistentVolumeClaimStatus. # noqa: E501
Return type:: str

to_dict(serialize=False): Returns the model properties as a dict

to_str(): Returns the string representation of the model