RunBatchJob.Builder (software.amazon.awscdk:stepfunctions-tasks 1.41.0 API)

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

Enclosing class:: RunBatchJob

@Stability(value=Experimental)
public static final class RunBatchJob.Builder
extends Object

A fluent builder for RunBatchJob.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunBatchJob.Builder`	`arraySize(Number arraySize)` The array size can be between 2 and 10,000.
`RunBatchJob.Builder`	`attempts(Number attempts)` The number of times to move a job to the RUNNABLE status.
`RunBatchJob`	`build()`
`RunBatchJob.Builder`	`containerOverrides(ContainerOverrides 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 RunBatchJob.Builder`	`create()` EXPERIMENTAL
`RunBatchJob.Builder`	`dependsOn(List<JobDependency> dependsOn)` A list of dependencies for the job.
`RunBatchJob.Builder`	`integrationPattern(ServiceIntegrationPattern integrationPattern)` The service integration pattern indicates different ways to call TerminateCluster.
`RunBatchJob.Builder`	`jobDefinition(IJobDefinition jobDefinition)` The job definition used by this job.
`RunBatchJob.Builder`	`jobName(String jobName)` The name of the job.
`RunBatchJob.Builder`	`jobQueue(IJobQueue jobQueue)` The job queue into which the job is submitted.
`RunBatchJob.Builder`	`payload(Map<String,Object> payload)` The payload to be passed as parametrs to the batch job.
`RunBatchJob.Builder`	`timeout(Duration timeout)` The timeout configuration for this SubmitJob operation.

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

- Method Detail
  - create
```
@Stability(value=Experimental)
public static RunBatchJob.Builder create()
```
    EXPERIMENTAL
    
    Returns:
    
    a new instance of RunBatchJob.Builder.
  - jobDefinition
```
@Stability(value=Experimental)
public RunBatchJob.Builder jobDefinition(IJobDefinition jobDefinition)
```
    The job definition used by this job.
    EXPERIMENTAL
    
    Parameters:
    
    jobDefinition - The job definition used by this job. This parameter is required.
    
    Returns:
    
    this
  - jobName
```
@Stability(value=Experimental)
public RunBatchJob.Builder jobName(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.
    EXPERIMENTAL
    
    Parameters:
    
    jobName - The name of the job. This parameter is required.
    
    Returns:
    
    this
  - jobQueue
```
@Stability(value=Experimental)
public RunBatchJob.Builder jobQueue(IJobQueue jobQueue)
```
    The job queue into which the job is submitted.
    EXPERIMENTAL
    
    Parameters:
    
    jobQueue - The job queue into which the job is submitted. This parameter is required.
    
    Returns:
    
    this
  - arraySize
```
@Stability(value=Experimental)
public RunBatchJob.Builder arraySize(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
    EXPERIMENTAL
    
    Parameters:
    
    arraySize - The array size can be between 2 and 10,000. This parameter is required.
    
    Returns:
    
    this
  - attempts
```
@Stability(value=Experimental)
public RunBatchJob.Builder attempts(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
    EXPERIMENTAL
    
    Parameters:
    
    attempts - The number of times to move a job to the RUNNABLE status. This parameter is required.
    
    Returns:
    
    this
  - containerOverrides
```
@Stability(value=Experimental)
public RunBatchJob.Builder containerOverrides(ContainerOverrides 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
    EXPERIMENTAL
    
    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
```
@Stability(value=Experimental)
public RunBatchJob.Builder dependsOn(List<JobDependency> dependsOn)
```
    A list of dependencies for the job.
    A job can depend upon a maximum of 20 jobs.
    Default: - No dependencies
    EXPERIMENTAL
    
    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
  - integrationPattern
```
@Stability(value=Experimental)
public RunBatchJob.Builder integrationPattern(ServiceIntegrationPattern integrationPattern)
```
    The service integration pattern indicates different ways to call TerminateCluster.
    The valid value is either FIRE_AND_FORGET or SYNC.
    Default: SYNC
    EXPERIMENTAL
    
    Parameters:
    
    integrationPattern - The service integration pattern indicates different ways to call TerminateCluster. This parameter is required.
    
    Returns:
    
    this
  - payload
```
@Stability(value=Experimental)
public RunBatchJob.Builder payload(Map<String,Object> payload)
```
    The payload to be passed as parametrs to the batch job.
    Default: - No parameters are passed
    EXPERIMENTAL
    
    Parameters:
    
    payload - The payload to be passed as parametrs to the batch job. This parameter is required.
    
    Returns:
    
    this
  - timeout
```
@Stability(value=Experimental)
public RunBatchJob.Builder timeout(Duration timeout)
```
    The timeout configuration for this SubmitJob operation.
    The minimum value for the timeout is 60 seconds.
    Default: - No timeout
    EXPERIMENTAL
    
    Parameters:
    
    timeout - The timeout configuration for this SubmitJob operation. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-timeout
  - build
```
@Stability(value=Experimental)
public RunBatchJob build()
```

Class RunBatchJob.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

jobDefinition

jobName

jobQueue

arraySize

attempts

containerOverrides

dependsOn

integrationPattern

payload

timeout

build