Struct k8s_openapi::api::core::v1::Secret

pub struct Secret {
    pub data: Option<BTreeMap<String, ByteString>>,
    pub immutable: Option<bool>,
    pub metadata: ObjectMeta,
    pub string_data: Option<BTreeMap<String, String>>,
    pub type_: Option<String>,
}

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Fields

data: Option<BTreeMap<String, ByteString>>

Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

immutable: Option<bool>

Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.

metadata: ObjectMeta

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

string_data: Option<BTreeMap<String, String>>

stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

type_: Option<String>

Used to facilitate programmatic handling of secret data.

Implementations

impl Secret

pub fn create_namespaced_secret(
    namespace: &str,
    body: &Secret,
    optional: CreateOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>

create a Secret

Use the returned crate::ResponseBody<crate::CreateResponse<Self>> constructor, or crate::CreateResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

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

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn delete_collection_namespaced_secret(
    namespace: &str,
    delete_optional: DeleteOptional<'_>,
    list_optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>

delete collection of Secret

Use the returned crate::ResponseBody<crate::DeleteResponse<crate::List<Self>>> constructor, or crate::DeleteResponse<crate::List<Self>> directly, to parse the HTTP response.

Arguments

• namespace

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

• delete_optional

  Delete options. Use Default::default() to not pass any.

• list_optional

  List options. Use Default::default() to not pass any.

impl Secret

pub fn delete_namespaced_secret(
    name: &str,
    namespace: &str,
    optional: DeleteOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>

delete a Secret

Use the returned crate::ResponseBody<crate::DeleteResponse<Self>> constructor, or crate::DeleteResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Secret

• namespace

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

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn list_namespaced_secret(
    namespace: &str,
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Secret

This operation only supports listing all items of this type.

Use the returned crate::ResponseBody<crate::ListResponse<Self>> constructor, or crate::ListResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

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

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn list_secret_for_all_namespaces(
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Secret

This operation only supports listing all items of this type.

Use the returned crate::ResponseBody<crate::ListResponse<Self>> constructor, or crate::ListResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn patch_namespaced_secret(
    name: &str,
    namespace: &str,
    body: &Patch,
    optional: PatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>

partially update the specified Secret

Use the returned crate::ResponseBody<crate::PatchResponse<Self>> constructor, or crate::PatchResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Secret

• namespace

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

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn read_namespaced_secret(
    name: &str,
    namespace: &str,
    optional: ReadNamespacedSecretOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReadNamespacedSecretResponse>), RequestError>

read the specified Secret

Use the returned crate::ResponseBody<ReadNamespacedSecretResponse> constructor, or ReadNamespacedSecretResponse directly, to parse the HTTP response.

Arguments

• name

  name of the Secret

• namespace

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

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn replace_namespaced_secret(
    name: &str,
    namespace: &str,
    body: &Secret,
    optional: ReplaceOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>

replace the specified Secret

Use the returned crate::ResponseBody<crate::ReplaceResponse<Self>> constructor, or crate::ReplaceResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Secret

• namespace

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

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn watch_namespaced_secret(
    namespace: &str,
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Secret

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned crate::ResponseBody<crate::WatchResponse<Self>> constructor, or crate::WatchResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

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

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Secret

pub fn watch_secret_for_all_namespaces(
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Secret

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned crate::ResponseBody<crate::WatchResponse<Self>> constructor, or crate::WatchResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

Trait Implementations

impl Clone for Secret

pub fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Default for Secret

pub fn default() -> Secret

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Secret

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

Deserialize this value from the given Serde deserializer.

impl ListableResource for Secret

pub const LIST_KIND: &'static str

The kind of the list type of the resource.

impl Metadata for Secret

type Ty = ObjectMeta

The type of the metadata object.

pub fn metadata(&self) -> &Self::Ty

Gets a reference to the metadata of this resource value.

pub fn metadata_mut(&mut self) -> &mut Self::Ty

Gets a mutable reference to the metadata of this resource value.

impl PartialEq<Secret> for Secret

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

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

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

This method tests for !=.

impl Resource for Secret

pub const API_VERSION: &'static str

The API version of the resource. This is a composite of Resource::GROUP and Resource::VERSION (eg "apiextensions.k8s.io/v1beta1") or just the version for resources without a group (eg "v1").

pub const GROUP: &'static str

The group of the resource, or the empty string if the resource doesn't have a group.

pub const KIND: &'static str

The kind of the resource.

pub const VERSION: &'static str

The version of the resource.

impl Serialize for Secret

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Secret