Struct kube::api::Object [−][src]
pub struct Object<P, U> where
P: Clone,
U: Clone, { pub types: Option<TypeMeta>, pub metadata: ObjectMeta, pub spec: P, pub status: Option<U>, }
client
only.Expand description
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
Trait Implementations
impl<'de, P, U> Deserialize<'de> for Object<P, U> where
P: Clone + Deserialize<'de>,
U: Clone + Deserialize<'de> + Default,
impl<'de, P, U> Deserialize<'de> for Object<P, U> where
P: Clone + Deserialize<'de>,
U: Clone + Deserialize<'de> + Default,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Object<P, U>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub 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. Read more
type Status = U
type Status = U
The type of the status
object
Returns an optional reference to the status
of the object
type DynamicType = ApiResource
type DynamicType = ApiResource
Type information for types that do not know their resource information at compile time. Read more
Returns group of this object
Returns version of this object
Returns kind of this object
Returns apiVersion of this object
Metadata that all persisted resources must have
Metadata that all persisted resources must have
Auto Trait Implementations
impl<P, U> RefUnwindSafe for Object<P, U> where
P: RefUnwindSafe,
U: RefUnwindSafe,
impl<P, U> UnwindSafe for Object<P, U> where
P: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Returns the name of the resource, panicking if it is
missing. Use this function if you know that name is set, for example
when resource was received from the apiserver.
Because of .metadata.generateName
field, in other contexts name
may be missing. Read more
The resource version
Unique ID (if you delete resource and then create a new resource with the same name, it will have different ID) Read more
Provides mutable access to the labels
Returns resource annotations
Provider mutable access to the annotations
Returns resource owner references
Provides mutable access to the owner references
Returns resource finalizers
Provides mutable access to the finalizers
type Output = T
type Output = T
Should always be Self