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(value="software.amazon.awssdk:codegen")
public final class DeleteJobExecutionRequest
extends IotRequest
implements ToCopyableBuilder<DeleteJobExecutionRequest.Builder,DeleteJobExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DeleteJobExecutionRequest.Builder	builder()
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	jobId() The ID of the job whose execution on a particular device will be deleted.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobId

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

toBuilder

public DeleteJobExecutionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteJobExecutionRequest.Builder,DeleteJobExecutionRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static DeleteJobExecutionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.