Package software.amazon.awssdk.services.iot.model

Class DeleteJobExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.DeleteJobExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteJobExecutionRequest.Builder,DeleteJobExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteJobExecutionRequest
extends IotRequest
implements ToCopyableBuilder<DeleteJobExecutionRequest.Builder,DeleteJobExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	executionNumber()	The ID of the job execution to be deleted.
Boolean	force()	(Optional) When true, you can delete a job execution which is "IN_PROGRESS".
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The ID of the job whose execution on a particular device will be deleted.
String	namespaceId()	The namespace used to indicate that a job is a customer-managed job.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteJobExecutionRequest.Builder>	serializableBuilderClass()
String	thingName()	The name of the thing whose job execution will be deleted.
DeleteJobExecutionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobId

public final String jobId()

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

Returns:

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

thingName

public final String thingName()

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

Returns:

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

executionNumber

public final 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.

Returns:

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.

force

public final 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.

Returns:

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

namespaceId

public final 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Returns:

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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

toBuilder

public DeleteJobExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteJobExecutionRequest.Builder,DeleteJobExecutionRequest>

Specified by:

toBuilder in class IotRequest

builder

public static DeleteJobExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteJobExecutionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo