software.amazon.awssdk.services.batch.model

Interface CancelJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>, SdkBuilder<CancelJobRequest.Builder,CancelJobRequest>, SdkRequest.Builder

Enclosing class:

CancelJobRequest

public static interface CancelJobRequest.Builder
extends BatchRequest.Builder, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

Method Summary

Modifier and Type	Method and Description
CancelJobRequest.Builder	jobId(String jobId) The AWS Batch job ID of the job to cancel.
CancelJobRequest.Builder	reason(String reason) A message to attach to the job that explains the reason for cancelling it.
CancelJobRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CancelJobRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

jobId

CancelJobRequest.Builder jobId(String jobId)

The AWS Batch job ID of the job to cancel.

Parameters:

jobId - The AWS 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 cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

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. This message is also recorded in the AWS Batch activity logs.

Returns:

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

requestOverrideConfig

CancelJobRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CancelJobRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.