Package software.amazon.awssdk.services.pipes.model

Interface PipeTargetBatchJobParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>, SdkBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>, SdkPojo
Enclosing class:
PipeTargetBatchJobParameters
public static interface PipeTargetBatchJobParameters.Builder extends SdkPojo, CopyableBuilder<PipeTargetBatchJobParameters.Builder,PipeTargetBatchJobParameters>

  • Method Details

    • arrayProperties

      PipeTargetBatchJobParameters.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 PipeTargetBatchJobParameters.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:

    • containerOverrides

      PipeTargetBatchJobParameters.Builder containerOverrides(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.

    • containerOverrides

      default PipeTargetBatchJobParameters.Builder containerOverrides(Consumer<BatchContainerOverrides.Builder> containerOverrides)

      The overrides that are sent to a container.

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

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

      Parameters:
      containerOverrides - a consumer that will call methods on BatchContainerOverrides.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dependsOn

      PipeTargetBatchJobParameters.Builder dependsOn(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.

    • dependsOn

      PipeTargetBatchJobParameters.Builder dependsOn(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.

    • dependsOn

      PipeTargetBatchJobParameters.Builder dependsOn(Consumer<BatchJobDependency.Builder>... 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dependsOn(List<BatchJobDependency>).

      Parameters:
      dependsOn - a consumer that will call methods on BatchJobDependency.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobDefinition

      PipeTargetBatchJobParameters.Builder jobDefinition(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.

    • jobName

      PipeTargetBatchJobParameters.Builder jobName(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.

    • parameters

      PipeTargetBatchJobParameters.Builder parameters(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.

    • retryStrategy

      PipeTargetBatchJobParameters.Builder retryStrategy(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.

    • retryStrategy

      default PipeTargetBatchJobParameters.Builder retryStrategy(Consumer<BatchRetryStrategy.Builder> 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.

      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: