CancelJobRequest.Builder (AWS Java SDK :: Services :: AWS Batch 2.52.0 API)

All Superinterfaces:: AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>, SdkBuilder<CancelJobRequest.Builder,CancelJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:: CancelJobRequest

@Mutable @NotThreadSafe public static interface CancelJobRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

Method Summary

Modifier and Type

Method

Description

CancelJobRequest.Builder

jobId(String jobId)

The Batch job ID of the job to cancel.

CancelJobRequest.Builder

overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

CancelJobRequest.Builder

overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

CancelJobRequest.Builder

reason(String reason)

A message to attach to the job that explains the reason for canceling it.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details
- jobId
  
  CancelJobRequest.Builder jobId(String jobId)
  
  The Batch job ID of the job to cancel.
  
  Parameters:
  
  jobId - The Batch job ID of the job to cancel.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
- reason
  
  CancelJobRequest.Builder reason(String reason)
  
  A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.
  
  This parameter has as limit of 1024 characters.
  
  Parameters:
  
  reason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.
  
  This parameter has as limit of 1024 characters.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
- overrideConfiguration
  
  CancelJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
  
  Specified by:
  
  overrideConfiguration in interface AwsRequest.Builder
- overrideConfiguration
  
  CancelJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
  
  Specified by:
  
  overrideConfiguration in interface AwsRequest.Builder