Class GetCommandExecutionResponse

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.GetCommandExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCommandExecutionResponse extends IotResponse implements ToCopyableBuilder<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>

  • Method Details

    • executionId

      public final String executionId()

      The unique identifier of the command execution.

      Returns:
      The unique identifier of the command execution.

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

    • targetArn

      public final String targetArn()

      The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

      Returns:
      The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

    • status

      public final CommandExecutionStatus status()

      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

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

      Returns:
      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

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

      Returns:
      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.
      See Also:

    • statusReason

      public final StatusReason statusReason()

      Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

      Returns:
      Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

    • hasResult

      public final boolean hasResult()
      For responses, this returns true if the service returned a value for the Result 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.

    • result

      public final Map<String,CommandExecutionResult> result()

      The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

      If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

      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 hasResult() method.

      Returns:
      The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

      If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters 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.

    • parameters

      public final Map<String,CommandParameterValue> parameters()

      The list of parameters that the StartCommandExecution API used when performing the command on the device.

      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 hasParameters() method.

      Returns:
      The list of parameters that the StartCommandExecution API used when performing the command on the device.

    • executionTimeoutSeconds

      public final Long executionTimeoutSeconds()

      Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

      Returns:
      Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

    • createdAt

      public final Instant createdAt()

      The timestamp, when the command execution was created.

      Returns:
      The timestamp, when the command execution was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp, when the command execution was last updated.

      Returns:
      The timestamp, when the command execution was last updated.

    • startedAt

      public final Instant startedAt()

      The timestamp, when the command execution was started.

      Returns:
      The timestamp, when the command execution was started.

    • completedAt

      public final Instant completedAt()

      The timestamp, when the command execution was completed.

      Returns:
      The timestamp, when the command execution was completed.

    • timeToLive

      public final Instant timeToLive()

      The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

      Returns:
      The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

    • toBuilder

      public GetCommandExecutionResponse.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<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetCommandExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCommandExecutionResponse.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.