Package software.amazon.awscdk.services.stepfunctions.tasks

Class BatchSubmitJobProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJobProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BatchSubmitJobProps>

Enclosing interface:

BatchSubmitJobProps

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

A builder for BatchSubmitJobProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BatchSubmitJobProps.Builder	arraySize(Number arraySize)	Sets the value of BatchSubmitJobProps.getArraySize()
BatchSubmitJobProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
BatchSubmitJobProps.Builder	attempts(Number attempts)	Sets the value of BatchSubmitJobProps.getAttempts()
BatchSubmitJobProps	build()	Builds the configured instance.
BatchSubmitJobProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
BatchSubmitJobProps.Builder	containerOverrides(BatchContainerOverrides containerOverrides)	Sets the value of BatchSubmitJobProps.getContainerOverrides()
BatchSubmitJobProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
BatchSubmitJobProps.Builder	dependsOn(List<? extends BatchJobDependency> dependsOn)	Sets the value of BatchSubmitJobProps.getDependsOn()
BatchSubmitJobProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
BatchSubmitJobProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
BatchSubmitJobProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
BatchSubmitJobProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
BatchSubmitJobProps.Builder	jobDefinitionArn(String jobDefinitionArn)	Sets the value of BatchSubmitJobProps.getJobDefinitionArn()
BatchSubmitJobProps.Builder	jobName(String jobName)	Sets the value of BatchSubmitJobProps.getJobName()
BatchSubmitJobProps.Builder	jobQueueArn(String jobQueueArn)	Sets the value of BatchSubmitJobProps.getJobQueueArn()
BatchSubmitJobProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
BatchSubmitJobProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
BatchSubmitJobProps.Builder	payload(TaskInput payload)	Sets the value of BatchSubmitJobProps.getPayload()
BatchSubmitJobProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
BatchSubmitJobProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
BatchSubmitJobProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
BatchSubmitJobProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
BatchSubmitJobProps.Builder	tags(Map<String,String> tags)	Sets the value of BatchSubmitJobProps.getTags()
BatchSubmitJobProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
BatchSubmitJobProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobDefinitionArn

@Stability(Stable)
public BatchSubmitJobProps.Builder jobDefinitionArn(String jobDefinitionArn)

Sets the value of BatchSubmitJobProps.getJobDefinitionArn()

Parameters:

jobDefinitionArn - The arn of the job definition used by this job. This parameter is required.

Returns:

this

jobName

@Stability(Stable)
public BatchSubmitJobProps.Builder jobName(String jobName)

Sets the value of BatchSubmitJobProps.getJobName()

Parameters:

jobName - The name of the job. This parameter is required. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

this

jobQueueArn

@Stability(Stable)
public BatchSubmitJobProps.Builder jobQueueArn(String jobQueueArn)

Sets the value of BatchSubmitJobProps.getJobQueueArn()

Parameters:

jobQueueArn - The arn of the job queue into which the job is submitted. This parameter is required.

Returns:

this

arraySize

@Stability(Stable)
public BatchSubmitJobProps.Builder arraySize(Number arraySize)

Sets the value of BatchSubmitJobProps.getArraySize()

Parameters:

arraySize - The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Returns:

this

attempts

@Stability(Stable)
public BatchSubmitJobProps.Builder attempts(Number attempts)

Sets the value of BatchSubmitJobProps.getAttempts()

Parameters:

attempts - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

Returns:

this

containerOverrides

@Stability(Stable)
public BatchSubmitJobProps.Builder containerOverrides(BatchContainerOverrides containerOverrides)

Sets the value of BatchSubmitJobProps.getContainerOverrides()

Parameters:

containerOverrides - A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

Returns:

this

dependsOn

@Stability(Stable)
public BatchSubmitJobProps.Builder dependsOn(List<? extends BatchJobDependency> dependsOn)

Sets the value of BatchSubmitJobProps.getDependsOn()

Parameters:

dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs.

Returns:

this

payload

@Stability(Stable)
public BatchSubmitJobProps.Builder payload(TaskInput payload)

Sets the value of BatchSubmitJobProps.getPayload()

Parameters:

payload - The payload to be passed as parameters to the batch job.

Returns:

this

tags

@Stability(Stable)
public BatchSubmitJobProps.Builder tags(Map<String,String> tags)

Sets the value of BatchSubmitJobProps.getTags()

Parameters:

tags - The tags applied to the job request.

Returns:

this

resultPath

@Stability(Stable)
public BatchSubmitJobProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(Stable)
public BatchSubmitJobProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

comment

@Stability(Stable)
public BatchSubmitJobProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public BatchSubmitJobProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public BatchSubmitJobProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public BatchSubmitJobProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public BatchSubmitJobProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public BatchSubmitJobProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public BatchSubmitJobProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public BatchSubmitJobProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public BatchSubmitJobProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public BatchSubmitJobProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public BatchSubmitJobProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

outputPath

@Stability(Stable)
public BatchSubmitJobProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

outputs

@Stability(Stable)
public BatchSubmitJobProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

build

@Stability(Stable)
public BatchSubmitJobProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BatchSubmitJobProps

Throws:

NullPointerException - if any required attribute was not provided