software.amazon.awssdk.services.iotjobsdataplane.model

Class UpdateJobExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotjobsdataplane.model.IotJobsDataPlaneRequest

software.amazon.awssdk.services.iotjobsdataplane.model.UpdateJobExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateJobExecutionRequest.Builder,UpdateJobExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
Long	executionNumber() Optional.
Long	expectedVersion() Optional.
<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()
Boolean	includeJobDocument() Optional.
Boolean	includeJobExecutionState() Optional.
String	jobId() The unique identifier assigned to this job when it was created.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateJobExecutionRequest.Builder>	serializableBuilderClass()
JobExecutionStatus	status() The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
String	statusAsString() The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).
Map<String,String>	statusDetails() Optional.
Long	stepTimeoutInMinutes() Specifies the amount of time this device has to finish execution of this job.
String	thingName() The name of the thing associated with the device.
UpdateJobExecutionRequest.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 assigned to this job when it was created.

Returns:

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

thingName

public String thingName()

The name of the thing associated with the device.

Returns:

The name of the thing associated with the device.

status

public JobExecutionStatus status()

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

If the service returns an enum value that is not available in the current SDK version, status will return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

See Also:

JobExecutionStatus

statusAsString

public String statusAsString()

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

If the service returns an enum value that is not available in the current SDK version, status will return JobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

See Also:

JobExecutionStatus

statusDetails

public Map<String,String> statusDetails()

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

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

Returns:

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

stepTimeoutInMinutes

public Long stepTimeoutInMinutes()

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Returns:

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT . Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

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

includeJobExecutionState

public Boolean includeJobExecutionState()

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Returns:

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

includeJobDocument

public Boolean includeJobDocument()

Optional. When set to true, the response contains the job document. The default is false.

Returns:

Optional. When set to true, the response contains the job document. The default is false.

executionNumber

public Long executionNumber()

Optional. A number that identifies a particular job execution on a particular device.

Returns:

Optional. A number that identifies a particular job execution on a particular device.

toBuilder

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

Specified by:

toBuilder in class IotJobsDataPlaneRequest

Returns:

a builder for type T

builder

public static UpdateJobExecutionRequest.Builder builder()

serializableBuilderClass

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