zio-k8s-client/com.coralogix.zio.k8s.model.events.v1beta1/Event

Event

case
class Event(action: Optional[String], deprecatedCount: Optional[Int], deprecatedFirstTimestamp: Optional[Time], deprecatedLastTimestamp: Optional[Time], deprecatedSource: Optional[EventSource], eventTime: MicroTime, metadata: Optional[ObjectMeta], note: Optional[String], reason: Optional[String], regarding: Optional[ObjectReference], related: Optional[ObjectReference], reportingController: Optional[String], reportingInstance: Optional[String], series: Optional[EventSeries], `type`: Optional[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.

Value Params
action

action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters.

deprecatedCount

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

note

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

reason is why the action was taken. It is human-readable. This field can have at most 128 characters.

reportingController

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

reportingInstance

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.

type

type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getAction: IO[K8sFailure, String]

action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters.

action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getDeprecatedCount: IO[K8sFailure, Int]

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

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getDeprecatedFirstTimestamp: IO[K8sFailure, Time]

Gets deprecatedFirstTimestamp.

Gets deprecatedFirstTimestamp.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getDeprecatedLastTimestamp: IO[K8sFailure, Time]

Gets deprecatedLastTimestamp.

Gets deprecatedLastTimestamp.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getDeprecatedSource: IO[K8sFailure, EventSource]

Gets deprecatedSource.

Gets deprecatedSource.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getEventTime: IO[K8sFailure, MicroTime]

Gets eventTime.

Gets eventTime.

This effect always succeeds, it is safe to use the field eventTime directly.

def getMetadata: IO[K8sFailure, ObjectMeta]

Gets metadata.

Gets metadata.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getNote: IO[K8sFailure, 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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getReason: IO[K8sFailure, String]

reason is why the action was taken. It is human-readable. This field can have at most 128 characters.

reason is why the action was taken. It is human-readable. This field can have at most 128 characters.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getRegarding: IO[K8sFailure, ObjectReference]

Gets regarding.

Gets regarding.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getRelated: IO[K8sFailure, ObjectReference]

Gets related.

Gets related.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getReportingController: IO[K8sFailure, 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.

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

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getReportingInstance: IO[K8sFailure, 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.

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.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getSeries: IO[K8sFailure, EventSeries]

Gets series.

Gets series.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getType: IO[K8sFailure, String]

type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable.

type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

def attachOwner(ownerName: String, ownerUid: String, ownerType: K8sResourceType): Event
Implicitly added by Ops

Attach another resource as the owner of this one

Attach another resource as the owner of this one

Value Params
ownerName

Owner's name

ownerType

Owner's resource type metadata

ownerUid

Owner's UID

Returns

Object with the attached owner described in its metadata

Inherited from
K8sObjectOps
def generation: Long
Implicitly added by Ops

Gets the geneation of the object or 0 if it is new

Gets the geneation of the object or 0 if it is new

Inherited from
K8sObjectOps
def getMetadata: IO[K8sFailure, ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def getName: IO[K8sFailure, String]
Implicitly added by Ops

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def getUid: IO[K8sFailure, String]
Implicitly added by Ops

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def isOwnedBy[OwnerT : ResourceMetadata](owner: OwnerT): Boolean
Implicitly added by Ops

Verifies ownership between the resources

Verifies ownership between the resources

Type Params
OwnerT

Type of the owner resource

Value Params
owner

Possible owner of this resource

Returns

True if owner owns this resource

Inherited from
K8sObjectOps
def mapMetadata(f: ObjectMeta => ObjectMeta): Event
Implicitly added by Ops

Creates a new object with its metadata modified by the given function f

Creates a new object with its metadata modified by the given function f

Value Params
f

Function to modify the object's metadata with

Returns

Object with modified metadata

Inherited from
K8sObjectOps
def metadata: Optional[ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object

Gets the metadata of the object

Inherited from
K8sObjectOps
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def tryAttachOwner[OwnerT : ResourceMetadata](owner: OwnerT): IO[K8sFailure, Event]
Implicitly added by Ops

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Type Params
OwnerT

Type of the owner

Value Params
owner

Owner resource

Returns

Object with the attached owner described in its metadata

Inherited from
K8sObjectOps

Concrete fields

override protected
val impl: K8sObject[Event]
Implicitly added by Ops
protected
val obj: Event
Implicitly added by Ops