Package software.amazon.awssdk.services.eventbridge.model

Interface BatchParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchParameters.Builder,BatchParameters>, SdkBuilder<BatchParameters.Builder,BatchParameters>, SdkPojo

Enclosing class:

BatchParameters

public static interface BatchParameters.Builder
extends SdkPojo, CopyableBuilder<BatchParameters.Builder,BatchParameters>

Method Summary

Modifier and Type	Method	Description
default BatchParameters.Builder	arrayProperties(Consumer<BatchArrayProperties.Builder> arrayProperties)	The array properties for the submitted job, such as the size of the array.
BatchParameters.Builder	arrayProperties(BatchArrayProperties arrayProperties)	The array properties for the submitted job, such as the size of the array.
BatchParameters.Builder	jobDefinition(String jobDefinition)	The ARN or name of the job definition to use if the event target is an Batch job.
BatchParameters.Builder	jobName(String jobName)	The name to use for this execution of the job, if the target is an Batch job.
default BatchParameters.Builder	retryStrategy(Consumer<BatchRetryStrategy.Builder> retryStrategy)	The retry strategy to use for failed jobs, if the target is an Batch job.
BatchParameters.Builder	retryStrategy(BatchRetryStrategy retryStrategy)	The retry strategy to use for failed jobs, if the target is an Batch job.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

jobDefinition

BatchParameters.Builder jobDefinition(String jobDefinition)

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

Parameters:

jobDefinition - The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobName

BatchParameters.Builder jobName(String jobName)

The name to use for this execution of the job, if the target is an Batch job.

Parameters:

jobName - The name to use for this execution of the job, if the target is an Batch job.

Returns:

Returns a reference to this object so that method calls can be chained together.

arrayProperties

BatchParameters.Builder arrayProperties(BatchArrayProperties arrayProperties)

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

Parameters:

arrayProperties - The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

Returns:

Returns a reference to this object so that method calls can be chained together.

arrayProperties

default BatchParameters.Builder arrayProperties(Consumer<BatchArrayProperties.Builder> arrayProperties)

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

This is a convenience method that creates an instance of the BatchArrayProperties.Builder avoiding the need to create one manually via BatchArrayProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to arrayProperties(BatchArrayProperties).

Parameters:

arrayProperties - a consumer that will call methods on BatchArrayProperties.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

arrayProperties(BatchArrayProperties)

retryStrategy

BatchParameters.Builder retryStrategy(BatchRetryStrategy retryStrategy)

The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Parameters:

retryStrategy - The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryStrategy

default BatchParameters.Builder retryStrategy(Consumer<BatchRetryStrategy.Builder> retryStrategy)

The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

This is a convenience method that creates an instance of the BatchRetryStrategy.Builder avoiding the need to create one manually via BatchRetryStrategy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryStrategy(BatchRetryStrategy).

Parameters:

retryStrategy - a consumer that will call methods on BatchRetryStrategy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retryStrategy(BatchRetryStrategy)