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

Class GetCommandExecutionResponse

    • Method Detail

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

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

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

      • 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