software.amazon.awssdk.services.iot.model

Interface CancelJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>, IotRequest.Builder, SdkBuilder<CancelJobRequest.Builder,CancelJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CancelJobRequest

public static interface CancelJobRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

Method Summary

Modifier and Type	Method and Description
CancelJobRequest.Builder	comment(String comment) An optional comment string describing why the job was canceled.
CancelJobRequest.Builder	force(Boolean force) (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
CancelJobRequest.Builder	jobId(String jobId) The unique identifier you assigned to this job when it was created.
CancelJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CancelJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CancelJobRequest.Builder	reasonCode(String reasonCode) (Optional)A reason code string that explains why the job was canceled.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

CancelJobRequest.Builder jobId(String jobId)

The unique identifier you assigned to this job when it was created.

Parameters:

jobId - The unique identifier you assigned to this job when it was created.

Returns:

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

reasonCode

CancelJobRequest.Builder reasonCode(String reasonCode)

(Optional)A reason code string that explains why the job was canceled.

Parameters:

reasonCode - (Optional)A reason code string that explains why the job was canceled.

Returns:

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

comment

CancelJobRequest.Builder comment(String comment)

An optional comment string describing why the job was canceled.

Parameters:

comment - An optional comment string describing why the job was canceled.

Returns:

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

force

CancelJobRequest.Builder force(Boolean force)

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Parameters:

force - (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false .

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

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 interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.