org.cdk8s.plus31.k8s.KubeEvent Maven / Gradle / Ivy
package org.cdk8s.plus31.k8s;
/**
* 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.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.577Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.k8s.KubeEvent")
public class KubeEvent extends org.cdk8s.ApiObject {
protected KubeEvent(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected KubeEvent(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
GVK = software.amazon.jsii.JsiiObject.jsiiStaticGet(org.cdk8s.plus31.k8s.KubeEvent.class, "GVK", software.amazon.jsii.NativeType.forClass(org.cdk8s.GroupVersionKind.class));
}
/**
* Defines a "io.k8s.api.events.v1.Event" API object.
*
* @param scope the scope in which to define this object. This parameter is required.
* @param id a scope-local name for the object. This parameter is required.
* @param props initialization props. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public KubeEvent(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.k8s.KubeEventProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Renders a Kubernetes manifest for "io.k8s.api.events.v1.Event".
*
* This can be used to inline resource manifests inside other objects (e.g. as templates).
*
* @param props initialization props. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static @org.jetbrains.annotations.NotNull java.lang.Object manifest(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.k8s.KubeEventProps props) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(org.cdk8s.plus31.k8s.KubeEvent.class, "manifest", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Renders the object to Kubernetes JSON.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public @org.jetbrains.annotations.NotNull java.lang.Object toJson() {
return software.amazon.jsii.Kernel.call(this, "toJson", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Returns the apiVersion and kind for "io.k8s.api.events.v1.Event".
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final static org.cdk8s.GroupVersionKind GVK;
/**
* A fluent builder for {@link org.cdk8s.plus31.k8s.KubeEvent}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope the scope in which to define this object. This parameter is required.
* @param id a scope-local name for the object. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final org.cdk8s.plus31.k8s.KubeEventProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new org.cdk8s.plus31.k8s.KubeEventProps.Builder();
}
/**
* eventTime is the time when this Event was first observed.
*
* It is required.
*
* @return {@code this}
* @param eventTime eventTime is the time when this Event was first observed. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder eventTime(final java.time.Instant eventTime) {
this.props.eventTime(eventTime);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param action action is what action was taken/failed regarding to the regarding object. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder action(final java.lang.String action) {
this.props.action(action);
return this;
}
/**
* deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
*
* @return {@code this}
* @param deprecatedCount deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deprecatedCount(final java.lang.Number deprecatedCount) {
this.props.deprecatedCount(deprecatedCount);
return this;
}
/**
* deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
*
* @return {@code this}
* @param deprecatedFirstTimestamp deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deprecatedFirstTimestamp(final java.time.Instant deprecatedFirstTimestamp) {
this.props.deprecatedFirstTimestamp(deprecatedFirstTimestamp);
return this;
}
/**
* deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
*
* @return {@code this}
* @param deprecatedLastTimestamp deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deprecatedLastTimestamp(final java.time.Instant deprecatedLastTimestamp) {
this.props.deprecatedLastTimestamp(deprecatedLastTimestamp);
return this;
}
/**
* deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
*
* @return {@code this}
* @param deprecatedSource deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deprecatedSource(final org.cdk8s.plus31.k8s.EventSource deprecatedSource) {
this.props.deprecatedSource(deprecatedSource);
return this;
}
/**
* Standard object's metadata.
*
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
* @return {@code this}
* @param metadata Standard object's metadata. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder metadata(final org.cdk8s.plus31.k8s.ObjectMeta metadata) {
this.props.metadata(metadata);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param note note is a human-readable description of the status of this operation. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder note(final java.lang.String note) {
this.props.note(note);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param reason reason is why the action was taken. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reason(final java.lang.String reason) {
this.props.reason(reason);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param regarding regarding contains the object this Event is about. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder regarding(final org.cdk8s.plus31.k8s.ObjectReference regarding) {
this.props.regarding(regarding);
return this;
}
/**
* related is the optional secondary object for more complex actions.
*
* E.g. when regarding object triggers a creation or deletion of related object.
*
* @return {@code this}
* @param related related is the optional secondary object for more complex actions. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder related(final org.cdk8s.plus31.k8s.ObjectReference related) {
this.props.related(related);
return this;
}
/**
* reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events.
*
* @return {@code this}
* @param 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. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reportingController(final java.lang.String reportingController) {
this.props.reportingController(reportingController);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param 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. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reportingInstance(final java.lang.String reportingInstance) {
this.props.reportingInstance(reportingInstance);
return this;
}
/**
* series is data about the Event series this event represents or nil if it's a singleton Event.
*
* @return {@code this}
* @param series series is data about the Event series this event represents or nil if it's a singleton Event. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder series(final org.cdk8s.plus31.k8s.EventSeries series) {
this.props.series(series);
return this;
}
/**
* 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.
*
* @return {@code this}
* @param type type is the type of this event (Normal, Warning), new types could be added in the future. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder type(final java.lang.String type) {
this.props.type(type);
return this;
}
/**
* @return a newly built instance of {@link org.cdk8s.plus31.k8s.KubeEvent}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public org.cdk8s.plus31.k8s.KubeEvent build() {
return new org.cdk8s.plus31.k8s.KubeEvent(
this.scope,
this.id,
this.props.build()
);
}
}
}