Interface CancelJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<CancelJobsRequest.Builder,CancelJobsRequest>, SdkBuilder<CancelJobsRequest.Builder,CancelJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CancelJobsRequest
@Mutable @NotThreadSafe public static interface CancelJobsRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<CancelJobsRequest.Builder,CancelJobsRequest>

  • Method Details

    • jobs

      CancelJobsRequest.Builder jobs(Collection<String> jobs)

      An array of up to 50 Batch job IDs of the jobs to cancel.

      Parameters:
      jobs - An array of up to 50 Batch job IDs of the jobs to cancel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobs

      CancelJobsRequest.Builder jobs(String... jobs)

      An array of up to 50 Batch job IDs of the jobs to cancel.

      Parameters:
      jobs - An array of up to 50 Batch job IDs of the jobs to cancel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reason

      CancelJobsRequest.Builder reason(String reason)

      A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.

      This parameter has a limit of 1024 characters.

      Parameters:
      reason - A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.

      This parameter has a limit of 1024 characters.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CancelJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CancelJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.