software.amazon.awssdk.services.iot.model

Class CancelJobExecutionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelJobExecutionRequest.Builder,CancelJobExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CancelJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CancelJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
Long	expectedVersion() (Optional) The expected current version of the job execution.
Boolean	force() (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.
<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 to be canceled.
List<SdkField<?>>	sdkFields()
static Class<? extends CancelJobExecutionRequest.Builder>	serializableBuilderClass()
Map<String,String>	statusDetails() A collection of name/value pairs that describe the status of the job execution.
String	thingName() The name of the thing whose execution of the job will be canceled.
CancelJobExecutionRequest.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 to be canceled.

Returns:

The ID of the job to be canceled.

thingName

public String thingName()

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

Returns:

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

force

public Boolean force()

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

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

Returns:

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false .

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

expectedVersion

public Long expectedVersion()

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Returns:

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

statusDetails

public Map<String,String> statusDetails()

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

toBuilder

public CancelJobExecutionRequest.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<CancelJobExecutionRequest.Builder,CancelJobExecutionRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static CancelJobExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CancelJobExecutionRequest.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.