Struct k8s_openapi::v1_10::api::apps::v1::StatefulSet

pub struct StatefulSet {
    pub api_version: Option<String>,
    pub kind: Option<String>,
    pub metadata: Option<ObjectMeta>,
    pub spec: Option<StatefulSetSpec>,
    pub status: Option<StatefulSetStatus>,
}

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

• Network: A single stable DNS and hostname.
• Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

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>

spec: Option<StatefulSetSpec>

Spec defines the desired identities of pods in this set.

status: Option<StatefulSetStatus>

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

Methods

impl StatefulSet

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

create a StatefulSet

Use CreateAppsV1NamespacedStatefulSetResponse 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 StatefulSet

pub fn delete_apps_v1_collection_namespaced_stateful_set(     namespace: &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>

delete collection of StatefulSet

Use DeleteAppsV1CollectionNamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• namespace

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

• 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. This limits the duration of the call, regardless of any activity or inactivity.

• watch

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

impl StatefulSet

pub fn delete_apps_v1_namespaced_stateful_set(     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 StatefulSet

Use DeleteAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

impl StatefulSet

pub fn list_apps_v1_namespaced_stateful_set(     namespace: &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>

list or watch objects of kind StatefulSet

Use ListAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• namespace

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

• 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. This limits the duration of the call, regardless of any activity or inactivity.

• watch

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

impl StatefulSet

pub fn list_apps_v1_stateful_set_for_all_namespaces(     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 StatefulSet

Use ListAppsV1StatefulSetForAllNamespacesResponse 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. This limits the duration of the call, regardless of any activity or inactivity.

• watch

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

impl StatefulSet

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

partially update the specified StatefulSet

Use PatchAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• body

• pretty

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

impl StatefulSet

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

partially update status of the specified StatefulSet

Use PatchAppsV1NamespacedStatefulSetStatusResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• body

• pretty

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

impl StatefulSet

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

read the specified StatefulSet

Use ReadAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

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

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

read status of the specified StatefulSet

Use ReadAppsV1NamespacedStatefulSetStatusResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• pretty

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

impl StatefulSet

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

replace the specified StatefulSet

Use ReplaceAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• body

• pretty

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

impl StatefulSet

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

replace status of the specified StatefulSet

Use ReplaceAppsV1NamespacedStatefulSetStatusResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• body

• pretty

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

impl StatefulSet

pub fn watch_apps_v1_namespaced_stateful_set(     name: &str,     namespace: &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 StatefulSet

Use WatchAppsV1NamespacedStatefulSetResponse to parse the HTTP response.

Arguments

• name

  name of the StatefulSet

• namespace

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

• 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. This limits the duration of the call, regardless of any activity or inactivity.

• watch

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

impl StatefulSet

pub fn watch_apps_v1_namespaced_stateful_set_list(     namespace: &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 individual changes to a list of StatefulSet

Use WatchAppsV1NamespacedStatefulSetListResponse to parse the HTTP response.

Arguments

• namespace

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

• 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. This limits the duration of the call, regardless of any activity or inactivity.

• watch

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

impl StatefulSet

pub fn watch_apps_v1_stateful_set_list_for_all_namespaces(     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 StatefulSet

Use WatchAppsV1StatefulSetListForAllNamespacesResponse 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. This limits the duration of the call, regardless of any activity or inactivity.

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

fn clone(&self) -> StatefulSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StatefulSet

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

Formats the value using the given formatter.

impl Default for StatefulSet

fn default() -> StatefulSet

Returns the "default value" for a type.

impl PartialEq for StatefulSet

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

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

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

This method tests for !=.

impl<'de> Deserialize<'de> for StatefulSet

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

Deserialize this value from the given Serde deserializer.

impl Serialize for StatefulSet

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

Serialize this value into the given Serde serializer.