Package org.cdk8s.plus24.k8s

Class CronJobSpecV1Beta1.Builder

java.lang.Object

org.cdk8s.plus24.k8s.CronJobSpecV1Beta1.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CronJobSpecV1Beta1>

Enclosing interface:

CronJobSpecV1Beta1

@Stability(Stable)
public static final class CronJobSpecV1Beta1.Builder
extends Object
implements software.amazon.jsii.Builder<CronJobSpecV1Beta1>

A builder for CronJobSpecV1Beta1

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CronJobSpecV1Beta1	build()	Builds the configured instance.
CronJobSpecV1Beta1.Builder	concurrencyPolicy(String concurrencyPolicy)	Sets the value of CronJobSpecV1Beta1.getConcurrencyPolicy()
CronJobSpecV1Beta1.Builder	failedJobsHistoryLimit(Number failedJobsHistoryLimit)	Sets the value of CronJobSpecV1Beta1.getFailedJobsHistoryLimit()
CronJobSpecV1Beta1.Builder	jobTemplate(JobTemplateSpecV1Beta1 jobTemplate)	Sets the value of CronJobSpecV1Beta1.getJobTemplate()
CronJobSpecV1Beta1.Builder	schedule(String schedule)	Sets the value of CronJobSpecV1Beta1.getSchedule()
CronJobSpecV1Beta1.Builder	startingDeadlineSeconds(Number startingDeadlineSeconds)	Sets the value of CronJobSpecV1Beta1.getStartingDeadlineSeconds()
CronJobSpecV1Beta1.Builder	successfulJobsHistoryLimit(Number successfulJobsHistoryLimit)	Sets the value of CronJobSpecV1Beta1.getSuccessfulJobsHistoryLimit()
CronJobSpecV1Beta1.Builder	suspend(Boolean suspend)	Sets the value of CronJobSpecV1Beta1.getSuspend()
CronJobSpecV1Beta1.Builder	timeZone(String timeZone)	Sets the value of CronJobSpecV1Beta1.getTimeZone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

jobTemplate

@Stability(Stable)
public CronJobSpecV1Beta1.Builder jobTemplate(JobTemplateSpecV1Beta1 jobTemplate)

Sets the value of CronJobSpecV1Beta1.getJobTemplate()

Parameters:

jobTemplate - Specifies the job that will be created when executing a CronJob. This parameter is required.

Returns:

this

schedule

@Stability(Stable)
public CronJobSpecV1Beta1.Builder schedule(String schedule)

Sets the value of CronJobSpecV1Beta1.getSchedule()

Parameters:

schedule - The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. This parameter is required.

Returns:

this

concurrencyPolicy

@Stability(Stable)
public CronJobSpecV1Beta1.Builder concurrencyPolicy(String concurrencyPolicy)

Sets the value of CronJobSpecV1Beta1.getConcurrencyPolicy()

Parameters:

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

Returns:

this

failedJobsHistoryLimit

@Stability(Stable)
public CronJobSpecV1Beta1.Builder failedJobsHistoryLimit(Number failedJobsHistoryLimit)

Sets the value of CronJobSpecV1Beta1.getFailedJobsHistoryLimit()

Parameters:

failedJobsHistoryLimit - The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

Returns:

this

startingDeadlineSeconds

@Stability(Stable)
public CronJobSpecV1Beta1.Builder startingDeadlineSeconds(Number startingDeadlineSeconds)

Sets the value of CronJobSpecV1Beta1.getStartingDeadlineSeconds()

Parameters:

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.

Returns:

this

successfulJobsHistoryLimit

@Stability(Stable)
public CronJobSpecV1Beta1.Builder successfulJobsHistoryLimit(Number successfulJobsHistoryLimit)

Sets the value of CronJobSpecV1Beta1.getSuccessfulJobsHistoryLimit()

Parameters:

successfulJobsHistoryLimit - The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.

Returns:

this

suspend

@Stability(Stable)
public CronJobSpecV1Beta1.Builder suspend(Boolean suspend)

Sets the value of CronJobSpecV1Beta1.getSuspend()

Parameters:

suspend - This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

Returns:

this

timeZone

@Stability(Stable)
public CronJobSpecV1Beta1.Builder timeZone(String timeZone)

Sets the value of CronJobSpecV1Beta1.getTimeZone()

Parameters:

timeZone - The time zone for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will rely on the time zone of the kube-controller-manager process. ALPHA: This field is in alpha and must be enabled via the `CronJobTimeZone` feature gate.

Returns:

this

build

@Stability(Stable)
public CronJobSpecV1Beta1 build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CronJobSpecV1Beta1>

Returns:

a new instance of CronJobSpecV1Beta1

Throws:

NullPointerException - if any required attribute was not provided