software.amazon.awssdk.services.iot.model

Class CancelJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CancelJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CancelJobRequest.Builder	builder()
String	comment() An optional comment string describing why the job was canceled.
boolean	equals(Object obj)
Boolean	force() (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
<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 unique identifier you assigned to this job when it was created.
String	reasonCode() (Optional)A reason code string that explains why the job was canceled.
List<SdkField<?>>	sdkFields()
static Class<? extends CancelJobRequest.Builder>	serializableBuilderClass()
CancelJobRequest.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 unique identifier you assigned to this job when it was created.

Returns:

The unique identifier you assigned to this job when it was created.

reasonCode

public String reasonCode()

(Optional)A reason code string that explains why the job was canceled.

Returns:

(Optional)A reason code string that explains why the job was canceled.

comment

public String comment()

An optional comment string describing why the job was canceled.

Returns:

An optional comment string describing why the job was canceled.

force

public Boolean force()

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Returns:

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

toBuilder

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

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static CancelJobRequest.Builder builder()

serializableBuilderClass

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