org.cdk8s.plus20

Class Job

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.plus20.Resource

org.cdk8s.plus20.Job

All Implemented Interfaces:

IPodSpec, IPodTemplate, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.34.0 (build 9b72778)",
           date="2021-09-21T00:27:37.483Z")
 @Stability(value=Stable)
public class Job
extends Resource
implements IPodTemplate

A Job creates one or more Pods and ensures that a specified number of them successfully terminate.

As pods successfully complete, the Job tracks the successful completions. When a specified number of successful completions is reached, the task (ie, Job) is complete. Deleting a Job will clean up the Pods it created. A simple case is to create one Job object in order to reliably run one Pod to completion. The Job object will start a new Pod if the first Pod fails or is deleted (for example due to a node hardware failure or a node reboot). You can also use a Job to run multiple Pods in parallel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Job.Builder A fluent builder for Job.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IPodTemplate

IPodTemplate.Jsii$Default, IPodTemplate.Jsii$Proxy

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Job(software.constructs.Construct scope, String id)
	Job(software.constructs.Construct scope, String id, JobProps props)
protected	Job(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Job(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Container	addContainer(ContainerProps container) Add a container to the pod.
void	addVolume(Volume volume) Add a volume to the pod.
org.cdk8s.Duration	getActiveDeadline() Duration before job is terminated.
protected org.cdk8s.ApiObject	getApiObject() The underlying cdk8s API object.
Number	getBackoffLimit() Number of retries before marking failed.
List<Container>	getContainers() The containers belonging to the pod.
org.cdk8s.ApiObjectMetadataDefinition	getPodMetadata() Provides read/write access to the underlying pod metadata of the resource.
RestartPolicy	getRestartPolicy() Restart policy for all containers within the pod.
IServiceAccount	getServiceAccount() The service account used to run this pod.
org.cdk8s.Duration	getTtlAfterFinished() TTL before the job is deleted after it is finished.
List<Volume>	getVolumes() The volumes associated with this pod.

Methods inherited from class org.cdk8s.plus20.Resource

getMetadata, getName

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, onValidate, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Job

protected Job(software.amazon.jsii.JsiiObjectRef objRef)

Job

protected Job(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Job

@Stability(value=Stable)
public Job(@NotNull
                                    software.constructs.Construct scope,
                                    @NotNull
                                    String id,
                                    @Nullable
                                    JobProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Job

@Stability(value=Stable)
public Job(@NotNull
                                    software.constructs.Construct scope,
                                    @NotNull
                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addContainer

@Stability(value=Stable)
 @NotNull
public Container addContainer(@NotNull
                                                                 ContainerProps container)

Add a container to the pod.

Specified by:

addContainer in interface IPodSpec

Parameters:

container - This parameter is required.

addVolume

@Stability(value=Stable)
public void addVolume(@NotNull
                                               Volume volume)

Add a volume to the pod.

Specified by:

addVolume in interface IPodSpec

Parameters:

volume - This parameter is required.

getApiObject

@Stability(value=Stable)
 @NotNull
protected org.cdk8s.ApiObject getApiObject()

The underlying cdk8s API object.

Specified by:

getApiObject in class Resource

See Also:

base.Resource.apiObject

getContainers

@Stability(value=Stable)
 @NotNull
public List<Container> getContainers()

The containers belonging to the pod.

Use addContainer to add containers.

Specified by:

getContainers in interface IPodSpec

getPodMetadata

@Stability(value=Stable)
 @NotNull
public org.cdk8s.ApiObjectMetadataDefinition getPodMetadata()

Provides read/write access to the underlying pod metadata of the resource.

Specified by:

getPodMetadata in interface IPodTemplate

getVolumes

@Stability(value=Stable)
 @NotNull
public List<Volume> getVolumes()

The volumes associated with this pod.

Use addVolume to add volumes.

Specified by:

getVolumes in interface IPodSpec

getActiveDeadline

@Stability(value=Stable)
 @Nullable
public org.cdk8s.Duration getActiveDeadline()

Duration before job is terminated.

If undefined, there is no deadline.

getBackoffLimit

@Stability(value=Stable)
 @Nullable
public Number getBackoffLimit()

Number of retries before marking failed.

getRestartPolicy

@Stability(value=Stable)
 @Nullable
public RestartPolicy getRestartPolicy()

Restart policy for all containers within the pod.

Specified by:

getRestartPolicy in interface IPodSpec

getServiceAccount

@Stability(value=Stable)
 @Nullable
public IServiceAccount getServiceAccount()

The service account used to run this pod.

Specified by:

getServiceAccount in interface IPodSpec

getTtlAfterFinished

@Stability(value=Stable)
 @Nullable
public org.cdk8s.Duration getTtlAfterFinished()

TTL before the job is deleted after it is finished.