software.amazon.awssdk.services.pipes.model

Class PipeTargetBatchJobParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeTargetBatchJobParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>

@Generated(value="software.amazon.awssdk:codegen")
public final class PipeTargetBatchJobParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>

The parameters for using an Batch job as a target.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipeTargetBatchJobParameters.Builder

Method Summary

Modifier and Type	Method and Description
BatchArrayProperties	arrayProperties() The array properties for the submitted job, such as the size of the array.
static PipeTargetBatchJobParameters.Builder	builder()
BatchContainerOverrides	containerOverrides() The overrides that are sent to a container.
List<BatchJobDependency>	dependsOn() A list of dependencies for the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDependsOn() For responses, this returns true if the service returned a value for the DependsOn property.
int	hashCode()
boolean	hasParameters() For responses, this returns true if the service returned a value for the Parameters property.
String	jobDefinition() The job definition used by this job.
String	jobName() The name of the job.
Map<String,String>	parameters() Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
BatchRetryStrategy	retryStrategy() The retry strategy to use for failed jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeTargetBatchJobParameters.Builder>	serializableBuilderClass()
PipeTargetBatchJobParameters.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arrayProperties

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.

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.

containerOverrides

public final BatchContainerOverrides containerOverrides()

The overrides that are sent to a container.

Returns:

The overrides that are sent to a container.

hasDependsOn

public final boolean hasDependsOn()

For responses, this returns true if the service returned a value for the DependsOn property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dependsOn

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDependsOn() method.

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.

jobDefinition

public final 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.

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.

jobName

public final 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 (_).

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 (_).

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameters

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

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.

retryStrategy

public final 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.

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.

toBuilder

public PipeTargetBatchJobParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>

builder

public static PipeTargetBatchJobParameters.Builder builder()

serializableBuilderClass

public static Class<? extends PipeTargetBatchJobParameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo