struct Kubernetes::Event

Overview

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.

Included Modules

Defined in:

generated/models/io_k8s_api_core_v1.cr
generated/models/io_k8s_api_events_v1.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(pull : ::JSON::PullParser) #

def self.new(*, __pull_for_json_serializable pull : ::JSON::PullParser) #

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Macro Detail

macro field(name, type = nil, **options, &block) #

Helper macro for defining fields with automatic camelCase conversion


Instance Method Detail

def action : String | Nil #

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.


def action=(action : String | Nil) #

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.


def api_version : String | Nil #

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources


def api_version=(api_version : String | Nil) #

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources


def count : Int32 | Nil #

The number of times this event has occurred.


def count=(count : Int32 | Nil) #

The number of times this event has occurred.


def deprecated_count : Int32 | Nil #

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


def deprecated_count=(deprecated_count : Int32 | Nil) #

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


def deprecated_first_timestamp : Time | Nil #

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


def deprecated_first_timestamp=(deprecated_first_timestamp : Time | Nil) #

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


def deprecated_last_timestamp : Time | Nil #

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


def deprecated_last_timestamp=(deprecated_last_timestamp : Time | Nil) #

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


def deprecated_source : EventSource | Nil #

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


def deprecated_source=(deprecated_source : EventSource | Nil) #

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


def event_time : MicroTime | Nil #

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


def event_time=(event_time : MicroTime | Nil) #

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


def first_timestamp : Time | Nil #

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)


def first_timestamp=(first_timestamp : Time | Nil) #

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)


def involved_object : ObjectReference | Nil #

The object that this event is about.


def involved_object=(involved_object : ObjectReference | Nil) #

The object that this event is about.


def kind : String | Nil #

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds


def kind=(kind : String | Nil) #

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds


def last_timestamp : Time | Nil #

The time at which the most recent occurrence of this event was recorded.


def last_timestamp=(last_timestamp : Time | Nil) #

The time at which the most recent occurrence of this event was recorded.


def message : String | Nil #

A human-readable description of the status of this operation.


def message=(message : String | Nil) #

A human-readable description of the status of this operation.


def metadata : ObjectMeta | Nil #

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


def metadata=(metadata : ObjectMeta | Nil) #

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


def note : String | Nil #

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.


def note=(note : String | Nil) #

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.


def reason : String | Nil #

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.


def reason=(reason : String | Nil) #

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.


def regarding : ObjectReference | Nil #

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.


def regarding=(regarding : ObjectReference | Nil) #

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.


def related : ObjectReference | Nil #

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


def related=(related : ObjectReference | Nil) #

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


def reporting_component : String | Nil #

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.


def reporting_component=(reporting_component : String | Nil) #

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.


def reporting_controller : String | Nil #

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


def reporting_controller=(reporting_controller : String | Nil) #

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


def reporting_instance : String | Nil #

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.


def reporting_instance=(reporting_instance : String | Nil) #

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.


def series : EventSeries | Nil #

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


def series=(series : EventSeries | Nil) #

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


def source : EventSource | Nil #

The component reporting this event. Should be a short machine understandable string.


def source=(source : EventSource | Nil) #

The component reporting this event. Should be a short machine understandable string.


def type : String | Nil #

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.


def type=(type : String | Nil) #

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.