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

Class BatchSubmitJobJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BatchSubmitJobJsonataProps>

Enclosing interface:

BatchSubmitJobJsonataProps

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

A builder for BatchSubmitJobJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of BatchSubmitJobJsonataProps.getJobDefinitionArn()

Parameters:

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

Returns:

this

jobName

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

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder jobQueueArn(String jobQueueArn)

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder arraySize(Number arraySize)

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder attempts(Number attempts)

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder containerOverrides(BatchContainerOverrides containerOverrides)

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder dependsOn(List<? extends BatchJobDependency> dependsOn)

Sets the value of BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder payload(TaskInput payload)

Sets the value of BatchSubmitJobJsonataProps.getPayload()

Parameters:

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

Returns:

this

tags

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

Sets the value of BatchSubmitJobJsonataProps.getTags()

Parameters:

tags - The tags applied to the job request.

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps.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

outputs

@Stability(Stable)
public BatchSubmitJobJsonataProps.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 BatchSubmitJobJsonataProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BatchSubmitJobJsonataProps

Throws:

NullPointerException - if any required attribute was not provided