@Generated(value="software.amazon.awssdk:codegen") public final class BatchParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchParameters.Builder,BatchParameters>
The custom parameters to be used when the target is an Batch job.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchParameters.Builder |
Modifier and Type | Method and Description |
---|---|
BatchArrayProperties |
arrayProperties()
The array properties for the submitted job, such as the size of the array.
|
static BatchParameters.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
jobDefinition()
The ARN or name of the job definition to use if the event target is an Batch job.
|
String |
jobName()
The name to use for this execution of the job, if the target is an Batch job.
|
BatchRetryStrategy |
retryStrategy()
The retry strategy to use for failed jobs, if the target is an Batch job.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchParameters.Builder> |
serializableBuilderClass() |
BatchParameters.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
public final String jobName()
The name to use for this execution of the job, if the target is an Batch job.
public final 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.
public final 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.
public BatchParameters.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<BatchParameters.Builder,BatchParameters>
public static BatchParameters.Builder builder()
public static Class<? extends BatchParameters.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.