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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancelJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CancelJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
int	hashCode()
boolean	hasStatusDetails()	For responses, this returns true if the service returned a value for the StatusDetails property.
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()
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 to be canceled.

Returns:

The ID of the job to be canceled.

thingName

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

hasStatusDetails

public final boolean hasStatusDetails()

For responses, this returns true if the service returned a value for the StatusDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statusDetails

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusDetails() method.

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

Specified by:

toBuilder in interface ToCopyableBuilder<CancelJobExecutionRequest.Builder,CancelJobExecutionRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CancelJobExecutionRequest.Builder builder()

serializableBuilderClass

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