software.amazon.awssdk.services.iot.model

Class DeleteJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteJobRequest.Builder,DeleteJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DeleteJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force() (Optional) When true, you can delete a job which is "IN_PROGRESS".
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId() The ID of the job to be deleted.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteJobRequest.Builder>	serializableBuilderClass()
DeleteJobRequest.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 String jobId()

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Returns:

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

force

public Boolean force()

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

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

Returns:

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

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

toBuilder

public DeleteJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteJobRequest.Builder,DeleteJobRequest>

Specified by:

toBuilder in class IotRequest

builder

public static DeleteJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo