BatchParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.BatchParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The custom parameters to be used when the target is an Batch job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchParameters()

Constructors
Constructor and Description
`BatchParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchParameters`	`clone()`
`boolean`	`equals(Object obj)`
`BatchArrayProperties`	`getArrayProperties()` The array properties for the submitted job, such as the size of the array.
`String`	`getJobDefinition()` The ARN or name of the job definition to use if the event target is an Batch job.
`String`	`getJobName()` The name to use for this execution of the job, if the target is an Batch job.
`BatchRetryStrategy`	`getRetryStrategy()` The retry strategy to use for failed jobs, if the target is an Batch job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArrayProperties(BatchArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`void`	`setJobDefinition(String jobDefinition)` The ARN or name of the job definition to use if the event target is an Batch job.
`void`	`setJobName(String jobName)` The name to use for this execution of the job, if the target is an Batch job.
`void`	`setRetryStrategy(BatchRetryStrategy retryStrategy)` The retry strategy to use for failed jobs, if the target is an Batch job.
`String`	`toString()` Returns a string representation of this object.
`BatchParameters`	`withArrayProperties(BatchArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`BatchParameters`	`withJobDefinition(String jobDefinition)` The ARN or name of the job definition to use if the event target is an Batch job.
`BatchParameters`	`withJobName(String jobName)` The name to use for this execution of the job, if the target is an Batch job.
`BatchParameters`	`withRetryStrategy(BatchRetryStrategy retryStrategy)` The retry strategy to use for failed jobs, if the target is an Batch job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchParameters
```
public BatchParameters()
```
- Method Detail
  - setJobDefinition
```
public void setJobDefinition(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.
  - getJobDefinition
```
public String getJobDefinition()
```
    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:
    
    The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
  - withJobDefinition
```
public BatchParameters withJobDefinition(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.
  - setJobName
```
public void setJobName(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.
  - getJobName
```
public String getJobName()
```
    The name to use for this execution of the job, if the target is an Batch job.
    
    Returns:
    
    The name to use for this execution of the job, if the target is an Batch job.
  - withJobName
```
public BatchParameters withJobName(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.
  - setArrayProperties
```
public void setArrayProperties(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.
  - getArrayProperties
```
public BatchArrayProperties getArrayProperties()
```
    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:
    
    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.
  - withArrayProperties
```
public BatchParameters withArrayProperties(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.
  - setRetryStrategy
```
public void setRetryStrategy(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.
  - getRetryStrategy
```
public BatchRetryStrategy getRetryStrategy()
```
    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:
    
    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.
  - withRetryStrategy
```
public BatchParameters withRetryStrategy(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class BatchParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchParameters

Method Detail

setJobDefinition

getJobDefinition

withJobDefinition

setJobName

getJobName

withJobName

setArrayProperties

getArrayProperties

withArrayProperties

setRetryStrategy

getRetryStrategy

withRetryStrategy

toString

equals

hashCode

clone

marshall