Struct k8s_openapi_ext::corev1::Secret

pub struct Secret {
    pub data: Option<BTreeMap<String, ByteString, Global>>,
    pub immutable: Option<bool>,
    pub metadata: ObjectMeta,
    pub string_data: Option<BTreeMap<String, String, Global>>,
    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, Global>>

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.

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, Global>>

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

type_: Option<String>

Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

Implementations

impl Secret

pub fn create(
    namespace: &str,
    body: &Secret,
    optional: CreateOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<CreateResponse<Secret>>), 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(
    namespace: &str,
    delete_optional: DeleteOptional<'_>,
    list_optional: ListOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<DeleteResponse<List<Secret>>>), 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(
    name: &str,
    namespace: &str,
    optional: DeleteOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<DeleteResponse<Secret>>), 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(
    namespace: &str,
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<ListResponse<Secret>>), 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_for_all_namespaces(
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<ListResponse<Secret>>), 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(
    name: &str,
    namespace: &str,
    body: &Patch,
    optional: PatchOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<PatchResponse<Secret>>), 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(
    name: &str,
    namespace: &str
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<ReadSecretResponse>), RequestError>

read the specified Secret

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

Arguments

• name

  name of the Secret

• namespace

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

impl Secret

pub fn replace(
    name: &str,
    namespace: &str,
    body: &Secret,
    optional: ReplaceOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<ReplaceResponse<Secret>>), 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(
    namespace: &str,
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<WatchResponse<Secret>>), 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_for_all_namespaces(
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8, Global>>, fn(StatusCode) -> ResponseBody<WatchResponse<Secret>>), 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

fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Default for Secret

fn default() -> Secret

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl ListableResource for Secret

const LIST_KIND: &'static str = "SecretList"

The kind of the list type of the resource.

impl Metadata for Secret

type Ty = ObjectMeta

The type of the metadata object.

fn metadata(&self) -> &<Secret as Metadata>::Ty

Gets a reference to the metadata of this resource value.

fn metadata_mut(&mut self) -> &mut <Secret as Metadata>::Ty

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

impl PartialEq<Secret> for Secret

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for Secret

const API_VERSION: &'static str = "v1"

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").

const GROUP: &'static str = ""

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

const KIND: &'static str = "Secret"

The kind of the resource.

const VERSION: &'static str = "v1"

The version of the resource.

const URL_PATH_SEGMENT: &'static str = "secrets"

The URL path segment used to construct URLs related to this resource.

type Scope = NamespaceResourceScope

Indicates whether the resource is namespace-scoped or cluster-scoped or a subresource.

impl SecretExt for Secret

fn new(name: impl ToString) -> Self

fn immutable(self, yes: bool) -> Self

fn type(self, type: impl ToString) -> Self

fn data(
    self,
    data: impl IntoIterator<Item = (impl ToString, ByteString)>
) -> Self

fn string_data(
    self,
    data: impl IntoIterator<Item = (impl ToString, impl ToString)>
) -> Self

fn image_pull_secret(name: impl ToString, data: impl ToString) -> Self

impl Serialize for Secret

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Secret