All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.cdk8s.plus23.k8s.CronJobSpecV1Beta1 Maven / Gradle / Ivy

package org.cdk8s.plus23.k8s;

/**
 * CronJobSpec describes how the job execution will look like and when it will actually run.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.75.0 (build 63bb957)", date = "2023-02-21T09:46:03.749Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus23.$Module.class, fqn = "cdk8s-plus-23.k8s.CronJobSpecV1Beta1")
@software.amazon.jsii.Jsii.Proxy(CronJobSpecV1Beta1.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface CronJobSpecV1Beta1 extends software.amazon.jsii.JsiiSerializable {

    /**
     * Specifies the job that will be created when executing a CronJob.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @org.jetbrains.annotations.NotNull org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1 getJobTemplate();

    /**
     * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @org.jetbrains.annotations.NotNull java.lang.String getSchedule();

    /**
     * Specifies how to treat concurrent executions of a Job.
     * 

* Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) default @org.jetbrains.annotations.Nullable java.lang.String getConcurrencyPolicy() { return null; } /** * The number of failed finished jobs to retain. *

* This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. *

* Default: 1. */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) default @org.jetbrains.annotations.Nullable java.lang.Number getFailedJobsHistoryLimit() { return null; } /** * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. *

* Missed jobs executions will be counted as failed ones. */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) default @org.jetbrains.annotations.Nullable java.lang.Number getStartingDeadlineSeconds() { return null; } /** * The number of successful finished jobs to retain. *

* This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. *

* Default: 3. */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) default @org.jetbrains.annotations.Nullable java.lang.Number getSuccessfulJobsHistoryLimit() { return null; } /** * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. *

* Defaults to false. *

* Default: false. */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) default @org.jetbrains.annotations.Nullable java.lang.Boolean getSuspend() { return null; } /** * @return a {@link Builder} of {@link CronJobSpecV1Beta1} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) static Builder builder() { return new Builder(); } /** * A builder for {@link CronJobSpecV1Beta1} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public static final class Builder implements software.amazon.jsii.Builder { org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1 jobTemplate; java.lang.String schedule; java.lang.String concurrencyPolicy; java.lang.Number failedJobsHistoryLimit; java.lang.Number startingDeadlineSeconds; java.lang.Number successfulJobsHistoryLimit; java.lang.Boolean suspend; /** * Sets the value of {@link CronJobSpecV1Beta1#getJobTemplate} * @param jobTemplate Specifies the job that will be created when executing a CronJob. This parameter is required. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder jobTemplate(org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1 jobTemplate) { this.jobTemplate = jobTemplate; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getSchedule} * @param schedule The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. This parameter is required. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder schedule(java.lang.String schedule) { this.schedule = schedule; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getConcurrencyPolicy} * @param concurrencyPolicy Specifies how to treat concurrent executions of a Job. * Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder concurrencyPolicy(java.lang.String concurrencyPolicy) { this.concurrencyPolicy = concurrencyPolicy; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getFailedJobsHistoryLimit} * @param failedJobsHistoryLimit The number of failed finished jobs to retain. * This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder failedJobsHistoryLimit(java.lang.Number failedJobsHistoryLimit) { this.failedJobsHistoryLimit = failedJobsHistoryLimit; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getStartingDeadlineSeconds} * @param startingDeadlineSeconds Optional deadline in seconds for starting the job if it misses scheduled time for any reason. * Missed jobs executions will be counted as failed ones. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder startingDeadlineSeconds(java.lang.Number startingDeadlineSeconds) { this.startingDeadlineSeconds = startingDeadlineSeconds; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getSuccessfulJobsHistoryLimit} * @param successfulJobsHistoryLimit The number of successful finished jobs to retain. * This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder successfulJobsHistoryLimit(java.lang.Number successfulJobsHistoryLimit) { this.successfulJobsHistoryLimit = successfulJobsHistoryLimit; return this; } /** * Sets the value of {@link CronJobSpecV1Beta1#getSuspend} * @param suspend This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. * Defaults to false. * @return {@code this} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) public Builder suspend(java.lang.Boolean suspend) { this.suspend = suspend; return this; } /** * Builds the configured instance. * @return a new instance of {@link CronJobSpecV1Beta1} * @throws NullPointerException if any required attribute was not provided */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) @Override public CronJobSpecV1Beta1 build() { return new Jsii$Proxy(this); } } /** * An implementation for {@link CronJobSpecV1Beta1} */ @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable) @software.amazon.jsii.Internal final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CronJobSpecV1Beta1 { private final org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1 jobTemplate; private final java.lang.String schedule; private final java.lang.String concurrencyPolicy; private final java.lang.Number failedJobsHistoryLimit; private final java.lang.Number startingDeadlineSeconds; private final java.lang.Number successfulJobsHistoryLimit; private final java.lang.Boolean suspend; /** * Constructor that initializes the object based on values retrieved from the JsiiObject. * @param objRef Reference to the JSII managed object. */ protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) { super(objRef); this.jobTemplate = software.amazon.jsii.Kernel.get(this, "jobTemplate", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1.class)); this.schedule = software.amazon.jsii.Kernel.get(this, "schedule", software.amazon.jsii.NativeType.forClass(java.lang.String.class)); this.concurrencyPolicy = software.amazon.jsii.Kernel.get(this, "concurrencyPolicy", software.amazon.jsii.NativeType.forClass(java.lang.String.class)); this.failedJobsHistoryLimit = software.amazon.jsii.Kernel.get(this, "failedJobsHistoryLimit", software.amazon.jsii.NativeType.forClass(java.lang.Number.class)); this.startingDeadlineSeconds = software.amazon.jsii.Kernel.get(this, "startingDeadlineSeconds", software.amazon.jsii.NativeType.forClass(java.lang.Number.class)); this.successfulJobsHistoryLimit = software.amazon.jsii.Kernel.get(this, "successfulJobsHistoryLimit", software.amazon.jsii.NativeType.forClass(java.lang.Number.class)); this.suspend = software.amazon.jsii.Kernel.get(this, "suspend", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class)); } /** * Constructor that initializes the object based on literal property values passed by the {@link Builder}. */ protected Jsii$Proxy(final Builder builder) { super(software.amazon.jsii.JsiiObject.InitializationMode.JSII); this.jobTemplate = java.util.Objects.requireNonNull(builder.jobTemplate, "jobTemplate is required"); this.schedule = java.util.Objects.requireNonNull(builder.schedule, "schedule is required"); this.concurrencyPolicy = builder.concurrencyPolicy; this.failedJobsHistoryLimit = builder.failedJobsHistoryLimit; this.startingDeadlineSeconds = builder.startingDeadlineSeconds; this.successfulJobsHistoryLimit = builder.successfulJobsHistoryLimit; this.suspend = builder.suspend; } @Override public final org.cdk8s.plus23.k8s.JobTemplateSpecV1Beta1 getJobTemplate() { return this.jobTemplate; } @Override public final java.lang.String getSchedule() { return this.schedule; } @Override public final java.lang.String getConcurrencyPolicy() { return this.concurrencyPolicy; } @Override public final java.lang.Number getFailedJobsHistoryLimit() { return this.failedJobsHistoryLimit; } @Override public final java.lang.Number getStartingDeadlineSeconds() { return this.startingDeadlineSeconds; } @Override public final java.lang.Number getSuccessfulJobsHistoryLimit() { return this.successfulJobsHistoryLimit; } @Override public final java.lang.Boolean getSuspend() { return this.suspend; } @Override @software.amazon.jsii.Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() { final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE; final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode(); data.set("jobTemplate", om.valueToTree(this.getJobTemplate())); data.set("schedule", om.valueToTree(this.getSchedule())); if (this.getConcurrencyPolicy() != null) { data.set("concurrencyPolicy", om.valueToTree(this.getConcurrencyPolicy())); } if (this.getFailedJobsHistoryLimit() != null) { data.set("failedJobsHistoryLimit", om.valueToTree(this.getFailedJobsHistoryLimit())); } if (this.getStartingDeadlineSeconds() != null) { data.set("startingDeadlineSeconds", om.valueToTree(this.getStartingDeadlineSeconds())); } if (this.getSuccessfulJobsHistoryLimit() != null) { data.set("successfulJobsHistoryLimit", om.valueToTree(this.getSuccessfulJobsHistoryLimit())); } if (this.getSuspend() != null) { data.set("suspend", om.valueToTree(this.getSuspend())); } final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode(); struct.set("fqn", om.valueToTree("cdk8s-plus-23.k8s.CronJobSpecV1Beta1")); struct.set("data", data); final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode(); obj.set("$jsii.struct", struct); return obj; } @Override public final boolean equals(final Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; CronJobSpecV1Beta1.Jsii$Proxy that = (CronJobSpecV1Beta1.Jsii$Proxy) o; if (!jobTemplate.equals(that.jobTemplate)) return false; if (!schedule.equals(that.schedule)) return false; if (this.concurrencyPolicy != null ? !this.concurrencyPolicy.equals(that.concurrencyPolicy) : that.concurrencyPolicy != null) return false; if (this.failedJobsHistoryLimit != null ? !this.failedJobsHistoryLimit.equals(that.failedJobsHistoryLimit) : that.failedJobsHistoryLimit != null) return false; if (this.startingDeadlineSeconds != null ? !this.startingDeadlineSeconds.equals(that.startingDeadlineSeconds) : that.startingDeadlineSeconds != null) return false; if (this.successfulJobsHistoryLimit != null ? !this.successfulJobsHistoryLimit.equals(that.successfulJobsHistoryLimit) : that.successfulJobsHistoryLimit != null) return false; return this.suspend != null ? this.suspend.equals(that.suspend) : that.suspend == null; } @Override public final int hashCode() { int result = this.jobTemplate.hashCode(); result = 31 * result + (this.schedule.hashCode()); result = 31 * result + (this.concurrencyPolicy != null ? this.concurrencyPolicy.hashCode() : 0); result = 31 * result + (this.failedJobsHistoryLimit != null ? this.failedJobsHistoryLimit.hashCode() : 0); result = 31 * result + (this.startingDeadlineSeconds != null ? this.startingDeadlineSeconds.hashCode() : 0); result = 31 * result + (this.successfulJobsHistoryLimit != null ? this.successfulJobsHistoryLimit.hashCode() : 0); result = 31 * result + (this.suspend != null ? this.suspend.hashCode() : 0); return result; } } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy