Interface TerminateJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<TerminateJobsRequest.Builder,TerminateJobsRequest>, SdkBuilder<TerminateJobsRequest.Builder,TerminateJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

TerminateJobsRequest

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

Method Summary

Modifier and Type	Method	Description
TerminateJobsRequest.Builder	jobs(String... jobs)	An array of up to 50 Batch job IDs of the jobs to terminate.
TerminateJobsRequest.Builder	jobs(Collection<String> jobs)	An array of up to 50 Batch job IDs of the jobs to terminate.
TerminateJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
TerminateJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
TerminateJobsRequest.Builder	reason(String reason)	A message to attach to the job that explains the reason for terminating 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

jobs

TerminateJobsRequest.Builder jobs(Collection<String> jobs)

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

Parameters:

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

Returns:

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

jobs

TerminateJobsRequest.Builder jobs(String... jobs)

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

Parameters:

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

Returns:

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

reason

TerminateJobsRequest.Builder reason(String reason)

A message to attach to the job that explains the reason for terminating 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 terminating 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

TerminateJobsRequest.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

TerminateJobsRequest.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.