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

Class GetCommandResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.GetCommandResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCommandResponse.Builder,GetCommandResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCommandResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetCommandResponse.Builder	builder()
String	commandArn()	The Amazon Resource Number (ARN) of the command.
String	commandId()	The unique identifier of the command.
Instant	createdAt()	The timestamp, when the command was created.
Boolean	deprecated()	Indicates whether the command has been deprecated.
String	description()	A short text description of the command.
String	displayName()	The user-friendly name in the console for the command.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMandatoryParameters()	For responses, this returns true if the service returned a value for the MandatoryParameters property.
Instant	lastUpdatedAt()	The timestamp, when the command was last updated.
List<CommandParameter>	mandatoryParameters()	A list of parameters for the command created.
CommandNamespace	namespace()	The namespace of the command.
String	namespaceAsString()	The namespace of the command.
CommandPayload	payload()	The payload object that you provided for the command.
Boolean	pendingDeletion()	Indicates whether the command is being deleted.
String	roleArn()	The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetCommandResponse.Builder>	serializableBuilderClass()
GetCommandResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

commandId

public final String commandId()

The unique identifier of the command.

Returns:

The unique identifier of the command.

commandArn

public final String commandArn()

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandId>

Returns:

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandId>

namespace

public final CommandNamespace namespace()

The namespace of the command.

If the service returns an enum value that is not available in the current SDK version, namespace will return CommandNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The namespace of the command.

See Also:

CommandNamespace

namespaceAsString

public final String namespaceAsString()

The namespace of the command.

If the service returns an enum value that is not available in the current SDK version, namespace will return CommandNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The namespace of the command.

See Also:

CommandNamespace

displayName

public final String displayName()

The user-friendly name in the console for the command.

Returns:

The user-friendly name in the console for the command.

description

public final String description()

A short text description of the command.

Returns:

A short text description of the command.

hasMandatoryParameters

public final boolean hasMandatoryParameters()

For responses, this returns true if the service returned a value for the MandatoryParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

mandatoryParameters

public final List<CommandParameter> mandatoryParameters()

A list of parameters for the command created.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMandatoryParameters() method.

Returns:

A list of parameters for the command created.

payload

public final CommandPayload payload()

The payload object that you provided for the command.

Returns:

The payload object that you provided for the command.

roleArn

public final String roleArn()

The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

Returns:

The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

createdAt

public final Instant createdAt()

The timestamp, when the command was created.

Returns:

The timestamp, when the command was created.

lastUpdatedAt

public final Instant lastUpdatedAt()

The timestamp, when the command was last updated.

Returns:

The timestamp, when the command was last updated.

deprecated

public final Boolean deprecated()

Indicates whether the command has been deprecated.

Returns:

Indicates whether the command has been deprecated.

pendingDeletion

public final Boolean pendingDeletion()

Indicates whether the command is being deleted.

Returns:

Indicates whether the command is being deleted.

toBuilder

public GetCommandResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCommandResponse.Builder,GetCommandResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetCommandResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetCommandResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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