Interface GetCommandResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetCommandResponse.Builder,
,GetCommandResponse> IotResponse.Builder
,SdkBuilder<GetCommandResponse.Builder,
,GetCommandResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetCommandResponse
-
Method Summary
Modifier and TypeMethodDescriptioncommandArn
(String commandArn) The Amazon Resource Number (ARN) of the command.The unique identifier of the command.The timestamp, when the command was created.deprecated
(Boolean deprecated) Indicates whether the command has been deprecated.description
(String description) A short text description of the command.displayName
(String displayName) The user-friendly name in the console for the command.lastUpdatedAt
(Instant lastUpdatedAt) The timestamp, when the command was last updated.mandatoryParameters
(Collection<CommandParameter> mandatoryParameters) A list of parameters for the command created.mandatoryParameters
(Consumer<CommandParameter.Builder>... mandatoryParameters) A list of parameters for the command created.mandatoryParameters
(CommandParameter... mandatoryParameters) A list of parameters for the command created.The namespace of the command.namespace
(CommandNamespace namespace) The namespace of the command.default GetCommandResponse.Builder
payload
(Consumer<CommandPayload.Builder> payload) The payload object that you provided for the command.payload
(CommandPayload payload) The payload object that you provided for the command.pendingDeletion
(Boolean pendingDeletion) Indicates whether the command is being deleted.The IAM role that you provided when creating the command withAWS-IoT-FleetWise
as the namespace.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
commandId
The unique identifier of the command.
- Parameters:
commandId
- The unique identifier of the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commandArn
The Amazon Resource Number (ARN) of the command. For example,
arn:aws:iot:<region>:<accountid>:command/<commandId>
- Parameters:
commandArn
- The Amazon Resource Number (ARN) of the command. For example,arn:aws:iot:<region>:<accountid>:command/<commandId>
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespace
The namespace of the command.
- Parameters:
namespace
- The namespace of the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
namespace
The namespace of the command.
- Parameters:
namespace
- The namespace of the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
displayName
The user-friendly name in the console for the command.
- Parameters:
displayName
- The user-friendly name in the console for the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A short text description of the command.
- Parameters:
description
- A short text description of the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mandatoryParameters
A list of parameters for the command created.
- Parameters:
mandatoryParameters
- A list of parameters for the command created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mandatoryParameters
A list of parameters for the command created.
- Parameters:
mandatoryParameters
- A list of parameters for the command created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mandatoryParameters
GetCommandResponse.Builder mandatoryParameters(Consumer<CommandParameter.Builder>... mandatoryParameters) A list of parameters for the command created.
This is a convenience method that creates an instance of theCommandParameter.Builder
avoiding the need to create one manually viaCommandParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomandatoryParameters(List<CommandParameter>)
.- Parameters:
mandatoryParameters
- a consumer that will call methods onCommandParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
payload
The payload object that you provided for the command.
- Parameters:
payload
- The payload object that you provided for the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
payload
The payload object that you provided for the command.
This is a convenience method that creates an instance of theCommandPayload.Builder
avoiding the need to create one manually viaCommandPayload.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topayload(CommandPayload)
.- Parameters:
payload
- a consumer that will call methods onCommandPayload.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The IAM role that you provided when creating the command with
AWS-IoT-FleetWise
as the namespace.- Parameters:
roleArn
- The IAM role that you provided when creating the command withAWS-IoT-FleetWise
as the namespace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The timestamp, when the command was created.
- Parameters:
createdAt
- The timestamp, when the command was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedAt
The timestamp, when the command was last updated.
- Parameters:
lastUpdatedAt
- The timestamp, when the command was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deprecated
Indicates whether the command has been deprecated.
- Parameters:
deprecated
- Indicates whether the command has been deprecated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingDeletion
Indicates whether the command is being deleted.
- Parameters:
pendingDeletion
- Indicates whether the command is being deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-