Struct kube_client::api::Object
source · [−]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
sourceimpl<'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,
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<Object<P, U>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
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
sourceimpl<P, U> HasStatus for Object<P, U> where
P: Clone,
U: Clone,
impl<P, U> HasStatus for Object<P, U> where
P: Clone,
U: Clone,
sourceimpl<P, U> Resource for Object<P, U> where
P: Clone,
U: Clone,
impl<P, U> Resource for Object<P, U> where
P: Clone,
U: Clone,
type DynamicType = ApiResource
type DynamicType = ApiResource
Type information for types that do not know their resource information at compile time. Read more
sourcefn group(dt: &ApiResource) -> Cow<'_, str>
fn group(dt: &ApiResource) -> Cow<'_, str>
Returns group of this object
sourcefn version(dt: &ApiResource) -> Cow<'_, str>
fn version(dt: &ApiResource) -> Cow<'_, str>
Returns version of this object
sourcefn kind(dt: &ApiResource) -> Cow<'_, str>
fn kind(dt: &ApiResource) -> Cow<'_, str>
Returns kind of this object
sourcefn api_version(dt: &ApiResource) -> Cow<'_, str>
fn api_version(dt: &ApiResource) -> Cow<'_, str>
Returns apiVersion of this object
sourcefn meta(&self) -> &ObjectMeta
fn meta(&self) -> &ObjectMeta
Metadata that all persisted resources must have
sourcefn meta_mut(&mut self) -> &mut ObjectMeta
fn meta_mut(&mut self) -> &mut ObjectMeta
Metadata that all persisted resources must have
sourcefn url_path(dt: &Self::DynamicType, namespace: Option<&str>) -> String
fn url_path(dt: &Self::DynamicType, namespace: Option<&str>) -> String
Creates a url path for http requests for this resource
sourcefn object_ref(&self, dt: &Self::DynamicType) -> ObjectReference
fn object_ref(&self, dt: &Self::DynamicType) -> ObjectReference
Generates an object reference for the resource
sourcefn controller_owner_ref(&self, dt: &Self::DynamicType) -> Option<OwnerReference>
fn controller_owner_ref(&self, dt: &Self::DynamicType) -> Option<OwnerReference>
Generates a controller owner reference pointing to this resource Read more
Auto Trait Implementations
impl<P, U> RefUnwindSafe for Object<P, U> where
P: RefUnwindSafe,
U: RefUnwindSafe,
impl<P, U> Send for Object<P, U> where
P: Send,
U: Send,
impl<P, U> Sync for Object<P, U> where
P: Sync,
U: Sync,
impl<P, U> Unpin for Object<P, U> where
P: Unpin,
U: Unpin,
impl<P, U> UnwindSafe for Object<P, U> where
P: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<K> ResourceExt for K where
K: Resource,
impl<K> ResourceExt for K where
K: Resource,
sourcefn name(&self) -> String
fn name(&self) -> String
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
sourcefn resource_version(&self) -> Option<String>
fn resource_version(&self) -> Option<String>
The resource version
sourcefn uid(&self) -> Option<String>
fn uid(&self) -> Option<String>
Unique ID (if you delete resource and then create a new resource with the same name, it will have different ID) Read more
sourcefn creation_timestamp(&self) -> Option<Time>
fn creation_timestamp(&self) -> Option<Time>
Returns the creation timestamp Read more
sourcefn labels_mut(&mut self) -> &mut BTreeMap<String, String>
fn labels_mut(&mut self) -> &mut BTreeMap<String, String>
Provides mutable access to the labels
sourcefn annotations(&self) -> &BTreeMap<String, String>
fn annotations(&self) -> &BTreeMap<String, String>
Returns resource annotations
sourcefn annotations_mut(&mut self) -> &mut BTreeMap<String, String>
fn annotations_mut(&mut self) -> &mut BTreeMap<String, String>
Provider mutable access to the annotations
sourcefn owner_references(&self) -> &[OwnerReference]
fn owner_references(&self) -> &[OwnerReference]
Returns resource owner references
sourcefn owner_references_mut(&mut self) -> &mut Vec<OwnerReference, Global>
fn owner_references_mut(&mut self) -> &mut Vec<OwnerReference, Global>
Provides mutable access to the owner references
sourcefn finalizers(&self) -> &[String]
fn finalizers(&self) -> &[String]
Returns resource finalizers
sourcefn finalizers_mut(&mut self) -> &mut Vec<String, Global>
fn finalizers_mut(&mut self) -> &mut Vec<String, Global>
Provides mutable access to the finalizers
sourcefn managed_fields(&self) -> &[ManagedFieldsEntry]
fn managed_fields(&self) -> &[ManagedFieldsEntry]
Returns managed fields
sourcefn managed_fields_mut(&mut self) -> &mut Vec<ManagedFieldsEntry, Global>
fn managed_fields_mut(&mut self) -> &mut Vec<ManagedFieldsEntry, Global>
Provides mutable access to managed fields
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more