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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCommandResponse.Builder,GetCommandResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.