Struct k8s_openapi::api::events::v1::Event

pub struct Event {

    pub action: Option<String>,
    pub deprecated_count: Option<i32>,
    pub deprecated_first_timestamp: Option<Time>,
    pub deprecated_last_timestamp: Option<Time>,
    pub deprecated_source: Option<EventSource>,
    pub event_time: MicroTime,
    pub metadata: ObjectMeta,
    pub note: Option<String>,
    pub reason: Option<String>,
    pub regarding: Option<ObjectReference>,
    pub related: Option<ObjectReference>,
    pub reporting_controller: Option<String>,
    pub reporting_instance: Option<String>,
    pub series: Option<EventSeries>,
    pub type_: Option<String>,
}

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

Fields

action: Option<String>

action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

deprecated_count: Option<i32>

deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.

deprecated_first_timestamp: Option<Time>

deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

deprecated_last_timestamp: Option<Time>

deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

deprecated_source: Option<EventSource>

deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.

event_time: MicroTime

eventTime is the time when this Event was first observed. It is required.

metadata: ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

note: Option<String>

note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.

reason: Option<String>

reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.

regarding: Option<ObjectReference>

regarding contains the object this Event is about. In most cases it’s an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.

related: Option<ObjectReference>

related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.

reporting_controller: Option<String>

reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events.

reporting_instance: Option<String>

reportingInstance is the ID of the controller instance, e.g. kubelet-xyzf. This field cannot be empty for new Events and it can have at most 128 characters.

series: Option<EventSeries>

series is data about the Event series this event represents or nil if it’s a singleton Event.

type_: Option<String>

type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.

Implementations

impl Event

pub fn create(
    namespace: &str,
    body: &Event,
    optional: CreateOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>

create an Event

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 Event

pub fn delete_collection(
    namespace: &str,
    delete_optional: DeleteOptional<'_>,
    list_optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>

delete collection of Event

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 Event

pub fn delete(
    name: &str,
    namespace: &str,
    optional: DeleteOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>

delete an Event

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

Arguments

• name

  name of the Event

• namespace

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

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Event

pub fn list_for_all_namespaces(
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Event

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 Event

pub fn list(
    namespace: &str,
    optional: ListOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Event

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 Event

pub fn patch(
    name: &str,
    namespace: &str,
    body: &Patch,
    optional: PatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>

partially update the specified Event

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

Arguments

• name

  name of the Event

• namespace

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

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Event

pub fn read(
    name: &str,
    namespace: &str
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReadEventResponse>), RequestError>

read the specified Event

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

Arguments

• name

  name of the Event

• namespace

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

impl Event

pub fn replace(
    name: &str,
    namespace: &str,
    body: &Event,
    optional: ReplaceOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>

replace the specified Event

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

Arguments

• name

  name of the Event

• namespace

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

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Event

pub fn watch_for_all_namespaces(
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Event

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.

impl Event

pub fn watch(
    namespace: &str,
    optional: WatchOptional<'_>
) -> Result<(Request<Vec<u8>>, fn(_: StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Event

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.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl DeepMerge for Event

fn merge_from(&mut self, other: Self)

Merge other into self.

impl<'de> Deserialize<'de> for Event

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

Deserialize this value from the given Serde deserializer.

impl ListableResource for Event

const LIST_KIND: &'static str = "EventList"

The kind of the list type of the resource.

impl Metadata for Event

type Ty = ObjectMeta

The type of the metadata object.

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

Gets a reference to the metadata of this resource value.

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

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

impl PartialEq<Event> for Event

fn eq(&self, other: &Event) -> 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 Event

const API_VERSION: &'static str = "events.k8s.io/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 = "events.k8s.io"

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

const KIND: &'static str = "Event"

The kind of the resource.

const VERSION: &'static str = "v1"

The version of the resource.

const URL_PATH_SEGMENT: &'static str = "events"

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 Serialize for Event

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Event