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

Interface GetCommandResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetCommandResponse.Builder,GetCommandResponse>, IotResponse.Builder, SdkBuilder<GetCommandResponse.Builder,GetCommandResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCommandResponse

public static interface GetCommandResponse.Builder
extends IotResponse.Builder, SdkPojo, CopyableBuilder<GetCommandResponse.Builder,GetCommandResponse>

Method Summary

Modifier and Type	Method	Description
GetCommandResponse.Builder	commandArn(String commandArn)	The Amazon Resource Number (ARN) of the command.
GetCommandResponse.Builder	commandId(String commandId)	The unique identifier of the command.
GetCommandResponse.Builder	createdAt(Instant createdAt)	The timestamp, when the command was created.
GetCommandResponse.Builder	deprecated(Boolean deprecated)	Indicates whether the command has been deprecated.
GetCommandResponse.Builder	description(String description)	A short text description of the command.
GetCommandResponse.Builder	displayName(String displayName)	The user-friendly name in the console for the command.
GetCommandResponse.Builder	lastUpdatedAt(Instant lastUpdatedAt)	The timestamp, when the command was last updated.
GetCommandResponse.Builder	mandatoryParameters(Collection<CommandParameter> mandatoryParameters)	A list of parameters for the command created.
GetCommandResponse.Builder	mandatoryParameters(Consumer<CommandParameter.Builder>... mandatoryParameters)	A list of parameters for the command created.
GetCommandResponse.Builder	mandatoryParameters(CommandParameter... mandatoryParameters)	A list of parameters for the command created.
GetCommandResponse.Builder	namespace(String namespace)	The namespace of the command.
GetCommandResponse.Builder	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.
GetCommandResponse.Builder	payload(CommandPayload payload)	The payload object that you provided for the command.
GetCommandResponse.Builder	pendingDeletion(Boolean pendingDeletion)	Indicates whether the command is being deleted.
GetCommandResponse.Builder	roleArn(String roleArn)	The IAM role that allows access to retrieve information about the command.

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 Detail

commandId

GetCommandResponse.Builder commandId(String 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

GetCommandResponse.Builder commandArn(String 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

GetCommandResponse.Builder namespace(String 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:

CommandNamespace, CommandNamespace

namespace

GetCommandResponse.Builder namespace(CommandNamespace 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:

CommandNamespace, CommandNamespace

displayName

GetCommandResponse.Builder displayName(String 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

GetCommandResponse.Builder description(String 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

GetCommandResponse.Builder mandatoryParameters(Collection<CommandParameter> 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(CommandParameter... 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 the CommandParameter.Builder avoiding the need to create one manually via CommandParameter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #mandatoryParameters(List).

Parameters:

mandatoryParameters - a consumer that will call methods on CommandParameter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#mandatoryParameters(java.util.Collection)

payload

GetCommandResponse.Builder payload(CommandPayload 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

default GetCommandResponse.Builder payload(Consumer<CommandPayload.Builder> payload)

The payload object that you provided for the command.

This is a convenience method that creates an instance of the CommandPayload.Builder avoiding the need to create one manually via CommandPayload.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(CommandPayload).

Parameters:

payload - a consumer that will call methods on CommandPayload.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

payload(CommandPayload)

roleArn

GetCommandResponse.Builder roleArn(String roleArn)

The IAM role that allows access to retrieve information about the command.

Parameters:

roleArn - The IAM role that allows access to retrieve information about the command.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

GetCommandResponse.Builder createdAt(Instant 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

GetCommandResponse.Builder lastUpdatedAt(Instant 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

GetCommandResponse.Builder deprecated(Boolean 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

GetCommandResponse.Builder pendingDeletion(Boolean 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.