software.amazon.awssdk.services.iot.model

Interface DeleteJobExecutionRequest.Builder

All Superinterfaces:

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

Enclosing class:

DeleteJobExecutionRequest

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

Method Summary

Modifier and Type	Method and Description
DeleteJobExecutionRequest.Builder	executionNumber(Long executionNumber) The ID of the job execution to be deleted.
DeleteJobExecutionRequest.Builder	force(Boolean force) (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
DeleteJobExecutionRequest.Builder	jobId(String jobId) The ID of the job whose execution on a particular device will be deleted.
DeleteJobExecutionRequest.Builder	namespaceId(String namespaceId) The namespace used to indicate that a job is a customer-managed job.
DeleteJobExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DeleteJobExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DeleteJobExecutionRequest.Builder	thingName(String thingName) The name of the thing whose job execution will be deleted.

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

equalsBySdkFields, 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

DeleteJobExecutionRequest.Builder jobId(String jobId)

The ID of the job whose execution on a particular device will be deleted.

Parameters:

jobId - The ID of the job whose execution on a particular device will be deleted.

Returns:

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

thingName

DeleteJobExecutionRequest.Builder thingName(String thingName)

The name of the thing whose job execution will be deleted.

Parameters:

thingName - The name of the thing whose job execution will be deleted.

Returns:

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

executionNumber

DeleteJobExecutionRequest.Builder executionNumber(Long executionNumber)

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Parameters:

executionNumber - The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Returns:

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

force

DeleteJobExecutionRequest.Builder force(Boolean force)

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Parameters:

force - (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Returns:

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

namespaceId

DeleteJobExecutionRequest.Builder namespaceId(String namespaceId)

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Parameters:

namespaceId - The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Returns:

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

overrideConfiguration

DeleteJobExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DeleteJobExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder