Interface GetCommandExecutionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetCommandExecutionRequest.Builder,
,GetCommandExecutionRequest> IotRequest.Builder
,SdkBuilder<GetCommandExecutionRequest.Builder,
,GetCommandExecutionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetCommandExecutionRequest
@Mutable
@NotThreadSafe
public static interface GetCommandExecutionRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<GetCommandExecutionRequest.Builder,GetCommandExecutionRequest>
-
Method Summary
Modifier and TypeMethodDescriptionexecutionId
(String executionId) The unique identifier for the command execution.includeResult
(Boolean includeResult) Can be used to specify whether to include the result of the command execution in theGetCommandExecution
API response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Number (ARN) of the device on which the command execution is being performed.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
executionId
The unique identifier for the command execution. This information is returned as a response of the
StartCommandExecution
API request.- Parameters:
executionId
- The unique identifier for the command execution. This information is returned as a response of theStartCommandExecution
API request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetArn
The Amazon Resource Number (ARN) of the device on which the command execution is being performed.
- Parameters:
targetArn
- The Amazon Resource Number (ARN) of the device on which the command execution is being performed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theAWS-IoT
namespace.- Parameters:
includeResult
- Can be used to specify whether to include the result of the command execution in theGetCommandExecution
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 theAWS-IoT
namespace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetCommandExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetCommandExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-