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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	executionNumber()	Optional.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
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 unique identifier assigned to this job when it was created.

Returns:

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

thingName

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeJobExecutionRequest.Builder,DescribeJobExecutionRequest>

Specified by:

toBuilder in class IotJobsDataPlaneRequest

builder

public static DescribeJobExecutionRequest.Builder builder()

serializableBuilderClass

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