public static interface DeleteJobRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<DeleteJobRequest.Builder,DeleteJobRequest>
| Modifier and Type | Method and Description |
|---|---|
DeleteJobRequest.Builder |
force(Boolean force)
(Optional) When true, you can delete a job which is "IN_PROGRESS".
|
DeleteJobRequest.Builder |
jobId(String jobId)
The ID of the job to be deleted.
|
DeleteJobRequest.Builder |
namespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
DeleteJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DeleteJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildDeleteJobRequest.Builder jobId(String jobId)
The ID of the job to be deleted.
After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
jobId - The ID of the job to be deleted.
After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
DeleteJobRequest.Builder force(Boolean force)
(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
force - (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a
job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default
is false. Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
DeleteJobRequest.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.
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.
DeleteJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderDeleteJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.