BatchSubmitJob.Builder

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJob.Builder

Enclosing class:: BatchSubmitJob

public static final class BatchSubmitJob.Builder
extends java.lang.Object

A fluent builder for BatchSubmitJob.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchSubmitJob.Builder`	`arraySize(java.lang.Number arraySize)` The array size can be between 2 and 10,000.
`BatchSubmitJob.Builder`	`attempts(java.lang.Number attempts)` The number of times to move a job to the RUNNABLE status.
`BatchSubmitJob`	`build()`
`BatchSubmitJob.Builder`	`comment(java.lang.String comment)` An optional description for this state.
`BatchSubmitJob.Builder`	`containerOverrides(BatchContainerOverrides 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.
`static BatchSubmitJob.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`BatchSubmitJob.Builder`	`dependsOn(java.util.List<? extends BatchJobDependency> dependsOn)` A list of dependencies for the job.
`BatchSubmitJob.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`BatchSubmitJob.Builder`	`inputPath(java.lang.String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`BatchSubmitJob.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`BatchSubmitJob.Builder`	`jobDefinitionArn(java.lang.String jobDefinitionArn)` The arn of the job definition used by this job.
`BatchSubmitJob.Builder`	`jobName(java.lang.String jobName)` The name of the job.
`BatchSubmitJob.Builder`	`jobQueueArn(java.lang.String jobQueueArn)` The arn of the job queue into which the job is submitted.
`BatchSubmitJob.Builder`	`outputPath(java.lang.String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`BatchSubmitJob.Builder`	`payload(TaskInput payload)` The payload to be passed as parameters to the batch job.
`BatchSubmitJob.Builder`	`resultPath(java.lang.String resultPath)` JSONPath expression to indicate where to inject the state's output.
`BatchSubmitJob.Builder`	`resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`BatchSubmitJob.Builder`	`timeout(Duration timeout)` Timeout for the state machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static BatchSubmitJob.Builder create(software.constructs.Construct scope,
                                            java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of BatchSubmitJob.Builder.
  - comment
```
public BatchSubmitJob.Builder comment(java.lang.String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
public BatchSubmitJob.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
public BatchSubmitJob.Builder inputPath(java.lang.String 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 {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
public BatchSubmitJob.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
public BatchSubmitJob.Builder outputPath(java.lang.String outputPath)
```
    JSONPath expression to select select a portion of the state output to pass to the next state.
    May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
public BatchSubmitJob.Builder resultPath(java.lang.String 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.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
public BatchSubmitJob.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> 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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
public BatchSubmitJob.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - jobDefinitionArn
```
public BatchSubmitJob.Builder jobDefinitionArn(java.lang.String jobDefinitionArn)
```
    The arn of the job definition used by this job.
    
    Parameters:
    
    jobDefinitionArn - The arn of the job definition used by this job. This parameter is required.
    
    Returns:
    
    this
  - jobName
```
public BatchSubmitJob.Builder jobName(java.lang.String jobName)
```
    The name of the job.
    The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    
    Parameters:
    
    jobName - The name of the job. This parameter is required.
    
    Returns:
    
    this
  - jobQueueArn
```
public BatchSubmitJob.Builder jobQueueArn(java.lang.String jobQueueArn)
```
    The arn of the job queue into which the job is submitted.
    
    Parameters:
    
    jobQueueArn - The arn of the job queue into which the job is submitted. This parameter is required.
    
    Returns:
    
    this
  - arraySize
```
public BatchSubmitJob.Builder arraySize(java.lang.Number 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.
    Default: - No array size
    
    Parameters:
    
    arraySize - The array size can be between 2 and 10,000. This parameter is required.
    
    Returns:
    
    this
  - attempts
```
public BatchSubmitJob.Builder attempts(java.lang.Number 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.
    Default: 1
    
    Parameters:
    
    attempts - The number of times to move a job to the RUNNABLE status. This parameter is required.
    
    Returns:
    
    this
  - containerOverrides
```
public BatchSubmitJob.Builder containerOverrides(BatchContainerOverrides 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.
    Default: - No container overrides
    
    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. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides
  - dependsOn
```
public BatchSubmitJob.Builder dependsOn(java.util.List<? extends BatchJobDependency> dependsOn)
```
    A list of dependencies for the job.
    A job can depend upon a maximum of 20 jobs.
    Default: - No dependencies
    
    Parameters:
    
    dependsOn - A list of dependencies for the job. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn
  - payload
```
public BatchSubmitJob.Builder payload(TaskInput payload)
```
    The payload to be passed as parameters to the batch job.
    Default: - No parameters are passed
    
    Parameters:
    
    payload - The payload to be passed as parameters to the batch job. This parameter is required.
    
    Returns:
    
    this
  - build
```
public BatchSubmitJob build()
```

Class BatchSubmitJob.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

jobDefinitionArn

jobName

jobQueueArn

arraySize

attempts

containerOverrides

dependsOn

payload

build