Interface CancelJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BatchRequest.Builder
,Buildable
,CopyableBuilder<CancelJobRequest.Builder,
,CancelJobRequest> SdkBuilder<CancelJobRequest.Builder,
,CancelJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CancelJobRequest
public static interface CancelJobRequest.Builder
extends BatchRequest.Builder, SdkPojo, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>
-
Method Summary
Modifier and TypeMethodDescriptionThe Batch job ID of the job to cancel.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFields
-
Method Details
-
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
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. This message is also recorded in the Batch activity logs.
- 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. This message is also recorded in the Batch activity logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CancelJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CancelJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-