software.amazon.awssdk.services.iotjobsdataplane.model

Class DescribeJobExecutionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeJobExecutionRequest.Builder,DescribeJobExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
Long	executionNumber() 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.
String	jobId() The unique identifier assigned to this job when it was created.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeJobExecutionRequest.Builder>	serializableBuilderClass()
String	thingName() The thing name associated with the device the job execution is running on.
DescribeJobExecutionRequest.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 thing name associated with the device the job execution is running on.

Returns:

The thing name associated with the device the job execution is running on.

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. If not specified, the latest job execution is returned.

Returns:

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

toBuilder

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

Specified by:

toBuilder in class IotJobsDataPlaneRequest

Returns:

a builder for type T

builder

public static DescribeJobExecutionRequest.Builder builder()

serializableBuilderClass

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