Package org.cdk8s.plus25.k8s

Interface KubeEventProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    KubeEventProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.634Z")
@Stability(Stable)
public interface KubeEventProps
extends software.amazon.jsii.JsiiSerializable
    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.

    • Method Detail

      • getEventTime

        @Stability(Stable)
@NotNull
Instant getEventTime()
        eventTime is the time when this Event was first observed.

        It is required.

      • getAction

        @Stability(Stable)
@Nullable
default String getAction()
        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.

      • getDeprecatedCount

        @Stability(Stable)
@Nullable
default Number getDeprecatedCount()
        deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.

      • getDeprecatedFirstTimestamp

        @Stability(Stable)
@Nullable
default Instant getDeprecatedFirstTimestamp()
        deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

      • getDeprecatedLastTimestamp

        @Stability(Stable)
@Nullable
default Instant getDeprecatedLastTimestamp()
        deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

      • getDeprecatedSource

        @Stability(Stable)
@Nullable
default EventSource getDeprecatedSource()
        deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.

      • getMetadata

        @Stability(Stable)
@Nullable
default ObjectMeta getMetadata()
        Standard object's metadata.

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

      • getNote

        @Stability(Stable)
@Nullable
default String getNote()
        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.

      • getReason

        @Stability(Stable)
@Nullable
default String getReason()
        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.

      • getRegarding

        @Stability(Stable)
@Nullable
default ObjectReference getRegarding()
        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.

      • getRelated

        @Stability(Stable)
@Nullable
default ObjectReference getRelated()
        related is the optional secondary object for more complex actions.

        E.g. when regarding object triggers a creation or deletion of related object.

      • getReportingController

        @Stability(Stable)
@Nullable
default String getReportingController()
        reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events.

      • getReportingInstance

        @Stability(Stable)
@Nullable
default String getReportingInstance()
        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.

      • getSeries

        @Stability(Stable)
@Nullable
default EventSeries getSeries()
        series is data about the Event series this event represents or nil if it's a singleton Event.

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        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.