Package software.amazon.awssdk.services.iot.model

Class GetCommandExecutionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCommandExecutionRequest.Builder,GetCommandExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCommandExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetCommandExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionId()	The unique identifier for the command execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeResult()	Can be used to specify whether to include the result of the command execution in the GetCommandExecution API response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetCommandExecutionRequest.Builder>	serializableBuilderClass()
String	targetArn()	The Amazon Resource Number (ARN) of the device on which the command execution is being performed.
GetCommandExecutionRequest.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

executionId

public final String executionId()

The unique identifier for the command execution. This information is returned as a response of the StartCommandExecution API request.

Returns:

The unique identifier for the command execution. This information is returned as a response of the StartCommandExecution API request.

targetArn

public final String targetArn()

The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

Returns:

The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

includeResult

public final Boolean includeResult()

Can be used to specify whether to include the result of the command execution in the GetCommandExecution API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the AWS-IoT namespace.

Returns:

Can be used to specify whether to include the result of the command execution in the GetCommandExecution API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the AWS-IoT namespace.

toBuilder

public GetCommandExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCommandExecutionRequest.Builder,GetCommandExecutionRequest>

Specified by:

toBuilder in class IotRequest

builder

public static GetCommandExecutionRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo