PipeTargetBatchJobParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.model.PipeTargetBatchJobParameters

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeTargetBatchJobParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

The parameters for using an Batch job as a target.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeTargetBatchJobParameters()

Constructors
Constructor and Description
`PipeTargetBatchJobParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeTargetBatchJobParameters`	`addParametersEntry(String key, String value)` Add a single Parameters entry
`PipeTargetBatchJobParameters`	`clearParametersEntries()` Removes all the entries added into Parameters.
`PipeTargetBatchJobParameters`	`clone()`
`boolean`	`equals(Object obj)`
`BatchArrayProperties`	`getArrayProperties()` The array properties for the submitted job, such as the size of the array.
`BatchContainerOverrides`	`getContainerOverrides()` The overrides that are sent to a container.
`List<BatchJobDependency>`	`getDependsOn()` A list of dependencies for the job.
`String`	`getJobDefinition()` The job definition used by this job.
`String`	`getJobName()` The name of the job.
`Map<String,String>`	`getParameters()` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`BatchRetryStrategy`	`getRetryStrategy()` The retry strategy to use for failed jobs.
`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`	`setContainerOverrides(BatchContainerOverrides containerOverrides)` The overrides that are sent to a container.
`void`	`setDependsOn(Collection<BatchJobDependency> dependsOn)` A list of dependencies for the job.
`void`	`setJobDefinition(String jobDefinition)` The job definition used by this job.
`void`	`setJobName(String jobName)` The name of the job.
`void`	`setParameters(Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`void`	`setRetryStrategy(BatchRetryStrategy retryStrategy)` The retry strategy to use for failed jobs.
`String`	`toString()` Returns a string representation of this object.
`PipeTargetBatchJobParameters`	`withArrayProperties(BatchArrayProperties arrayProperties)` The array properties for the submitted job, such as the size of the array.
`PipeTargetBatchJobParameters`	`withContainerOverrides(BatchContainerOverrides containerOverrides)` The overrides that are sent to a container.
`PipeTargetBatchJobParameters`	`withDependsOn(BatchJobDependency... dependsOn)` A list of dependencies for the job.
`PipeTargetBatchJobParameters`	`withDependsOn(Collection<BatchJobDependency> dependsOn)` A list of dependencies for the job.
`PipeTargetBatchJobParameters`	`withJobDefinition(String jobDefinition)` The job definition used by this job.
`PipeTargetBatchJobParameters`	`withJobName(String jobName)` The name of the job.
`PipeTargetBatchJobParameters`	`withParameters(Map<String,String> parameters)` Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
`PipeTargetBatchJobParameters`	`withRetryStrategy(BatchRetryStrategy retryStrategy)` The retry strategy to use for failed jobs.

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

- Constructor Detail
  - PipeTargetBatchJobParameters
```
public PipeTargetBatchJobParameters()
```
- Method Detail
  - 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 PipeTargetBatchJobParameters 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.
  - setContainerOverrides
```
public void setContainerOverrides(BatchContainerOverrides containerOverrides)
```
    The overrides that are sent to a container.
    
    Parameters:
    
    containerOverrides - The overrides that are sent to a container.
  - getContainerOverrides
```
public BatchContainerOverrides getContainerOverrides()
```
    The overrides that are sent to a container.
    
    Returns:
    
    The overrides that are sent to a container.
  - withContainerOverrides
```
public PipeTargetBatchJobParameters withContainerOverrides(BatchContainerOverrides containerOverrides)
```
    The overrides that are sent to a container.
    
    Parameters:
    
    containerOverrides - The overrides that are sent to a container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDependsOn
```
public List<BatchJobDependency> getDependsOn()
```
    A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    Returns:
    
    A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
  - setDependsOn
```
public void setDependsOn(Collection<BatchJobDependency> dependsOn)
```
    A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    Parameters:
    
    dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
  - withDependsOn
```
public PipeTargetBatchJobParameters withDependsOn(BatchJobDependency... dependsOn)
```
    A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    NOTE: This method appends the values to the existing list (if any). Use setDependsOn(java.util.Collection) or withDependsOn(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDependsOn
```
public PipeTargetBatchJobParameters withDependsOn(Collection<BatchJobDependency> dependsOn)
```
    A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    Parameters:
    
    dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDefinition
```
public void setJobDefinition(String jobDefinition)
```
    The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
    
    Parameters:
    
    jobDefinition - The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
  - getJobDefinition
```
public String getJobDefinition()
```
    The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
    
    Returns:
    
    The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
  - withJobDefinition
```
public PipeTargetBatchJobParameters withJobDefinition(String jobDefinition)
```
    The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
    
    Parameters:
    
    jobDefinition - The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    Parameters:
    
    jobName - The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
  - getJobName
```
public String getJobName()
```
    The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    Returns:
    
    The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
  - withJobName
```
public PipeTargetBatchJobParameters withJobName(String jobName)
```
    The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    Parameters:
    
    jobName - The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,String> getParameters()
```
    Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
  - setParameters
```
public void setParameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
  - withParameters
```
public PipeTargetBatchJobParameters withParameters(Map<String,String> parameters)
```
    Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
    
    Parameters:
    
    parameters - Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public PipeTargetBatchJobParameters addParametersEntry(String key,
                                                       String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public PipeTargetBatchJobParameters clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    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. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
  - getRetryStrategy
```
public BatchRetryStrategy getRetryStrategy()
```
    The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
    
    Returns:
    
    The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
  - withRetryStrategy
```
public PipeTargetBatchJobParameters withRetryStrategy(BatchRetryStrategy retryStrategy)
```
    The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
    
    Parameters:
    
    retryStrategy - The retry strategy to use for failed jobs. When a retry strategy is specified 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 PipeTargetBatchJobParameters 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.

Did this page help you?

Class PipeTargetBatchJobParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeTargetBatchJobParameters

Method Detail

setArrayProperties

getArrayProperties

withArrayProperties

setContainerOverrides

getContainerOverrides

withContainerOverrides

getDependsOn

setDependsOn

withDependsOn

withDependsOn

setJobDefinition

getJobDefinition

withJobDefinition

setJobName

getJobName

withJobName

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setRetryStrategy

getRetryStrategy

withRetryStrategy

toString

equals

hashCode

clone

marshall