Struct kube_runtime::events::Event

source ·
pub struct Event {
    pub type_: EventType,
    pub reason: String,
    pub note: Option<String>,
    pub action: String,
    pub secondary: Option<ObjectReference>,
}
Expand description

Minimal event type for publishing through Recorder::publish.

All string fields must be human readable.

Fields§

§type_: EventType

The event severity.

Shows up in kubectl describe as Type.

§reason: String

The short reason explaining why the action was taken.

This must be at most 128 characters, generally in PascalCase. Shows up in kubectl describe as Reason.

§note: Option<String>

A optional description of the status of the action.

This must be at most 1kB in size. Shows up in kubectl describe as Message.

§action: String

The action that was taken (either successfully or unsuccessfully) against main object

This must be at most 128 characters. It does not currently show up in kubectl describe. A common convention is a short identifier of the action that caused the outcome described in reason. Usually denoted in PascalCase.

§secondary: Option<ObjectReference>

Optional secondary object related to the main object

Some events are emitted for actions that affect multiple objects. secondary can be populated to capture this detail.

For example: the event concerns a Deployment and it affects the current ReplicaSet underneath it. You would therefore populate events using the object reference of the ReplicaSet.

Set secondary to None, instead, if the event affects only the object whose reference you passed to Recorder::new.

§Naming note

secondary is mapped to related in Events API.

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more