Struct k8s_openapi::v1_8::api::storage::v1::StorageClass

pub struct StorageClass {
    pub allow_volume_expansion: Option<bool>,
    pub api_version: Option<String>,
    pub kind: Option<String>,
    pub metadata: Option<ObjectMeta>,
    pub mount_options: Option<Vec<String>>,
    pub parameters: Option<BTreeMap<String, String>>,
    pub provisioner: String,
    pub reclaim_policy: Option<String>,
}

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Fields

allow_volume_expansion: Option<bool>

AllowVolumeExpansion shows whether the storage class allow volume expand

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

mount_options: Option<Vec<String>>

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters: Option<BTreeMap<String, String>>

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner: String

Provisioner indicates the type of the provisioner.

reclaim_policy: Option<String>

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

Methods

impl StorageClass

pub fn create_storage_v1_storage_class(     body: &StorageClass,     pretty: Option<&str> ) -> Result<Request<Vec<u8>>, RequestError>

create a StorageClass

Use CreateStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• body

• pretty

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

impl StorageClass

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

delete collection of StorageClass

Use DeleteStorageV1CollectionStorageClassResponse to parse the HTTP response.

Arguments

• continue_

  The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

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

• limit

  limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

• 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 StorageClass

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

delete a StorageClass

Use DeleteStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• name

  name of the StorageClass

• 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 StorageClass

pub fn list_storage_v1_storage_class(     continue_: Option<&str>,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     limit: Option<i64>,     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 StorageClass

Use ListStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• continue_

  The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

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

• limit

  limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

• 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 StorageClass

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

partially update the specified StorageClass

Use PatchStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• name

  name of the StorageClass

• body

• pretty

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

impl StorageClass

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

read the specified StorageClass

Use ReadStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• name

  name of the StorageClass

• 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 StorageClass

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

replace the specified StorageClass

Use ReplaceStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• name

  name of the StorageClass

• body

• pretty

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

impl StorageClass

pub fn watch_storage_v1_storage_class(     name: &str,     continue_: Option<&str>,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     limit: Option<i64>,     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 StorageClass

Use WatchStorageV1StorageClassResponse to parse the HTTP response.

Arguments

• name

  name of the StorageClass

• continue_

  The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

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

• limit

  limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

• 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 StorageClass

pub fn watch_storage_v1_storage_class_list(     continue_: Option<&str>,     field_selector: Option<&str>,     include_uninitialized: Option<bool>,     label_selector: Option<&str>,     limit: Option<i64>,     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 StorageClass

Use WatchStorageV1StorageClassListResponse to parse the HTTP response.

Arguments

• continue_

  The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

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

• limit

  limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

• 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 StorageClass

fn clone(&self) -> StorageClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageClass

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

Formats the value using the given formatter.

impl Default for StorageClass

fn default() -> StorageClass

Returns the "default value" for a type.

impl PartialEq for StorageClass

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

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

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

This method tests for !=.

impl<'de> Deserialize<'de> for StorageClass

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

Deserialize this value from the given Serde deserializer.

impl Serialize for StorageClass

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

Serialize this value into the given Serde serializer.