Struct k8s_openapi::v1_7::kubernetes::pkg::api::v1::PersistentVolumeClaim

pub struct PersistentVolumeClaim {
    pub api_version: Option<String>,
    pub kind: Option<String>,
    pub metadata: Option<ObjectMeta>,
    pub spec: Option<PersistentVolumeClaimSpec>,
    pub status: Option<PersistentVolumeClaimStatus>,
}

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Fields

api_version: Option<String>

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

kind: Option<String>

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

metadata: Option<ObjectMeta>

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

spec: Option<PersistentVolumeClaimSpec>

Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

status: Option<PersistentVolumeClaimStatus>

Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Methods

impl PersistentVolumeClaim

pub fn create_core_v1_namespaced_persistent_volume_claim(     namespace: &str,     body: &PersistentVolumeClaim,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

create a PersistentVolumeClaim

Use CreateCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• body

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn delete_core_v1_collection_namespaced_persistent_volume_claim(     namespace: &str,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

delete collection of PersistentVolumeClaim

Use DeleteCoreV1CollectionNamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

impl PersistentVolumeClaim

pub fn delete_core_v1_namespaced_persistent_volume_claim(     name: &str,     namespace: &str,     grace_period_seconds: Option<i64>,     orphan_dependents: Option<bool>,     pretty: Option<&str>,     propagation_policy: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

delete a PersistentVolumeClaim

Use DeleteCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• body

• grace_period_seconds

  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

• orphan_dependents

  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

• pretty

  If 'true', then the output is pretty printed.

• propagation_policy

  Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

impl PersistentVolumeClaim

pub fn list_core_v1_namespaced_persistent_volume_claim(     namespace: &str,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

list or watch objects of kind PersistentVolumeClaim

Use ListCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

impl PersistentVolumeClaim

pub fn list_core_v1_persistent_volume_claim_for_all_namespaces(     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

list or watch objects of kind PersistentVolumeClaim

Use ListCoreV1PersistentVolumeClaimForAllNamespacesResponse to parse the HTTP response.

Arguments

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

impl PersistentVolumeClaim

pub fn patch_core_v1_namespaced_persistent_volume_claim(     name: &str,     namespace: &str,     body: &Patch,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

partially update the specified PersistentVolumeClaim

Use PatchCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• body

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn patch_core_v1_namespaced_persistent_volume_claim_status(     name: &str,     namespace: &str,     body: &Patch,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

partially update status of the specified PersistentVolumeClaim

Use PatchCoreV1NamespacedPersistentVolumeClaimStatusResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• body

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn read_core_v1_namespaced_persistent_volume_claim(     name: &str,     namespace: &str,     exact: Option<bool>,     export: Option<bool>,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

read the specified PersistentVolumeClaim

Use ReadCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• exact

  Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

• export

  Should this value be exported. Export strips fields that a user can not specify.

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn read_core_v1_namespaced_persistent_volume_claim_status(     name: &str,     namespace: &str,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

read status of the specified PersistentVolumeClaim

Use ReadCoreV1NamespacedPersistentVolumeClaimStatusResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn replace_core_v1_namespaced_persistent_volume_claim(     name: &str,     namespace: &str,     body: &PersistentVolumeClaim,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

replace the specified PersistentVolumeClaim

Use ReplaceCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• body

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn replace_core_v1_namespaced_persistent_volume_claim_status(     name: &str,     namespace: &str,     body: &PersistentVolumeClaim,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

replace status of the specified PersistentVolumeClaim

Use ReplaceCoreV1NamespacedPersistentVolumeClaimStatusResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• body

• pretty

  If 'true', then the output is pretty printed.

impl PersistentVolumeClaim

pub fn watch_core_v1_namespaced_persistent_volume_claim(     name: &str,     namespace: &str,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

watch changes to an object of kind PersistentVolumeClaim

Use WatchCoreV1NamespacedPersistentVolumeClaimResponse to parse the HTTP response.

Arguments

• name

  name of the PersistentVolumeClaim

• namespace

  object name and auth scope, such as for teams and projects

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

impl PersistentVolumeClaim

pub fn watch_core_v1_namespaced_persistent_volume_claim_list(     namespace: &str,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

watch individual changes to a list of PersistentVolumeClaim

Use WatchCoreV1NamespacedPersistentVolumeClaimListResponse to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

impl PersistentVolumeClaim

pub fn watch_core_v1_persistent_volume_claim_list_for_all_namespaces(     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     pretty: Option<&str>,     resource_version: Option<&str>,     timeout_seconds: Option<i64>,     watch: Option<bool> ) -> Result<Request<Vec<u8>>, RequestError>

watch individual changes to a list of PersistentVolumeClaim

Use WatchCoreV1PersistentVolumeClaimListForAllNamespacesResponse to parse the HTTP response.

Arguments

• field_selector

  A selector to restrict the list of returned objects by their fields. Defaults to everything.

• include_uninitialized

  If true, partially initialized resources are included in the response.

• label_selector

  A selector to restrict the list of returned objects by their labels. Defaults to everything.

• pretty

  If 'true', then the output is pretty printed.

• resource_version

  When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

• timeout_seconds

  Timeout for the list/watch call.

• watch

  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Trait Implementations

impl Clone for PersistentVolumeClaim

fn clone(&self) -> PersistentVolumeClaim

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PersistentVolumeClaim

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

Formats the value using the given formatter.

impl Default for PersistentVolumeClaim

fn default() -> PersistentVolumeClaim

Returns the "default value" for a type.

impl PartialEq for PersistentVolumeClaim

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'de> Deserialize<'de> for PersistentVolumeClaim

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where     D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PersistentVolumeClaim

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where     S: Serializer,

Serialize this value into the given Serde serializer.