org.cdk8s.plus20

Class JobProps.Builder

java.lang.Object

org.cdk8s.plus20.JobProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobProps>

Enclosing interface:

JobProps

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

A builder for JobProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JobProps.Builder	activeDeadline(org.cdk8s.Duration activeDeadline) Sets the value of JobProps.getActiveDeadline()
JobProps.Builder	backoffLimit(Number backoffLimit) Sets the value of JobProps.getBackoffLimit()
JobProps	build() Builds the configured instance.
JobProps.Builder	containers(List<? extends ContainerProps> containers) Sets the value of PodSpecProps.getContainers()
JobProps.Builder	metadata(org.cdk8s.ApiObjectMetadata metadata) Sets the value of ResourceProps.getMetadata()
JobProps.Builder	podMetadata(org.cdk8s.ApiObjectMetadata podMetadata) Sets the value of PodTemplateProps.getPodMetadata()
JobProps.Builder	restartPolicy(RestartPolicy restartPolicy) Sets the value of PodSpecProps.getRestartPolicy()
JobProps.Builder	serviceAccount(IServiceAccount serviceAccount) Sets the value of PodSpecProps.getServiceAccount()
JobProps.Builder	ttlAfterFinished(org.cdk8s.Duration ttlAfterFinished) Sets the value of JobProps.getTtlAfterFinished()
JobProps.Builder	volumes(List<? extends Volume> volumes) Sets the value of PodSpecProps.getVolumes()

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

activeDeadline

@Stability(value=Stable)
public JobProps.Builder activeDeadline(org.cdk8s.Duration activeDeadline)

Sets the value of JobProps.getActiveDeadline()

Parameters:

activeDeadline - Specifies the duration the job may be active before the system tries to terminate it.

Returns:

this

backoffLimit

@Stability(value=Stable)
public JobProps.Builder backoffLimit(Number backoffLimit)

Sets the value of JobProps.getBackoffLimit()

Parameters:

backoffLimit - Specifies the number of retries before marking this job failed.

Returns:

this

ttlAfterFinished

@Stability(value=Stable)
public JobProps.Builder ttlAfterFinished(org.cdk8s.Duration ttlAfterFinished)

Sets the value of JobProps.getTtlAfterFinished()

Parameters:

ttlAfterFinished - Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.

Returns:

this

metadata

@Stability(value=Stable)
public JobProps.Builder metadata(org.cdk8s.ApiObjectMetadata metadata)

Sets the value of ResourceProps.getMetadata()

Parameters:

metadata - Metadata that all persisted resources must have, which includes all objects users must create.

Returns:

this

podMetadata

@Stability(value=Stable)
public JobProps.Builder podMetadata(org.cdk8s.ApiObjectMetadata podMetadata)

Sets the value of PodTemplateProps.getPodMetadata()

Parameters:

podMetadata - The pod metadata.

Returns:

this

containers

@Stability(value=Stable)
public JobProps.Builder containers(List<? extends ContainerProps> containers)

Sets the value of PodSpecProps.getContainers()

Parameters:

containers - List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()

Returns:

this

restartPolicy

@Stability(value=Stable)
public JobProps.Builder restartPolicy(RestartPolicy restartPolicy)

Sets the value of PodSpecProps.getRestartPolicy()

Parameters:

restartPolicy - Restart policy for all containers within the pod.

Returns:

this

serviceAccount

@Stability(value=Stable)
public JobProps.Builder serviceAccount(IServiceAccount serviceAccount)

Sets the value of PodSpecProps.getServiceAccount()

Parameters:

serviceAccount - A service account provides an identity for processes that run in a Pod. When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

Returns:

this

volumes

@Stability(value=Stable)
public JobProps.Builder volumes(List<? extends Volume> volumes)

Sets the value of PodSpecProps.getVolumes()

Parameters:

volumes - List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using podSpec.addVolume()

Returns:

this

build

@Stability(value=Stable)
public JobProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JobProps

Throws:

NullPointerException - if any required attribute was not provided