Struct kube_client::api::Object

pub struct Object<P, U>where
    P: Clone,
    U: Clone,{
    pub types: Option<TypeMeta>,
    pub metadata: ObjectMeta,
    pub spec: P,
    pub status: Option<U>,
}

Available on crate feature client only.

A standard Kubernetes object with .spec and .status.

This is a convenience struct provided for serialization/deserialization. It is slightly stricter than [’DynamicObject`] in that it enforces the spec/status convention, and as such will not in general work with all api-discovered resources.

This can be used to tie existing resources to smaller, local struct variants to optimize for memory use. E.g. if you are only interested in a few fields, but you store tons of them in memory with reflectors.

Fields

types: Option<TypeMeta>

The type fields, not always present

metadata: ObjectMeta

Resource metadata

Contains information common to most resources about the Resource, including the object name, annotations, labels and more.

spec: P

The Spec struct of a resource. I.e. PodSpec, DeploymentSpec, etc.

This defines the desired state of the Resource as specified by the user.

status: Option<U>

The Status of a resource. I.e. PodStatus, DeploymentStatus, etc.

This publishes the state of the Resource as observed by the controller. Use U = NotUsed when a status does not exist.

Implementations

impl<P, U> Object<P, U>where
    P: Clone,
    U: Clone,

pub fn new(name: &str, ar: &ApiResource, spec: P) -> Object<P, U>

A constructor that takes Resource values from an ApiResource

pub fn within(self, ns: &str) -> Object<P, U>

Attach a namespace to an Object

Trait Implementations

impl<P, U> Clone for Object<P, U>where
    P: Clone,
    U: Clone,

fn clone(&self) -> Object<P, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P, U> Debug for Object<P, U>where
    P: Debug + Clone,
    U: Debug + Clone,

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

Formats the value using the given formatter.

impl<'de, P, U> Deserialize<'de> for Object<P, U>where
    P: Clone + Deserialize<'de>,
    U: Clone + Deserialize<'de> + Default,

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Object<P, U>, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P, U> HasSpec for Object<P, U>where
    P: Clone,
    U: Clone,

type Spec = P

The type of the spec of this resource

fn spec(&self) -> &<Object<P, U> as HasSpec>::Spec

Returns a reference to the spec of the object

fn spec_mut(&mut self) -> &mut <Object<P, U> as HasSpec>::Spec

Returns a mutable reference to the spec of the object

impl<P, U> HasStatus for Object<P, U>where
    P: Clone,
    U: Clone,

type Status = U

The type of the status object

fn status(&self) -> Option<&<Object<P, U> as HasStatus>::Status>

Returns an optional reference to the status of the object

fn status_mut(&mut self) -> &mut Option<<Object<P, U> as HasStatus>::Status>

Returns an optional mutable reference to the status of the object

impl<P, U> Resource for Object<P, U>where
    P: Clone,
    U: Clone,

type DynamicType = ApiResource

Type information for types that do not know their resource information at compile time.

type Scope = DynamicResourceScope

Type information for the api scope of the resource when known at compile time

fn group(dt: &ApiResource) -> Cow<'_, str>

Returns group of this object

fn version(dt: &ApiResource) -> Cow<'_, str>

Returns version of this object

fn kind(dt: &ApiResource) -> Cow<'_, str>

Returns kind of this object

fn plural(dt: &ApiResource) -> Cow<'_, str>

Returns the plural name of the kind

fn api_version(dt: &ApiResource) -> Cow<'_, str>

Returns apiVersion of this object

fn meta(&self) -> &ObjectMeta

Metadata that all persisted resources must have

fn meta_mut(&mut self) -> &mut ObjectMeta

Metadata that all persisted resources must have

fn url_path(dt: &Self::DynamicType, namespace: Option<&str>) -> String

Creates a url path for http requests for this resource

fn object_ref(&self, dt: &Self::DynamicType) -> ObjectReference

Generates an object reference for the resource

fn controller_owner_ref(&self, dt: &Self::DynamicType) -> Option<OwnerReference>

Generates a controller owner reference pointing to this resource

impl<P, U> Serialize for Object<P, U>where
    P: Clone + Serialize,
    U: Clone + Serialize,

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.