Class CommandExecutionSummary

java.lang.Object
software.amazon.awssdk.services.iot.model.CommandExecutionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CommandExecutionSummary.Builder,CommandExecutionSummary>
@Generated("software.amazon.awssdk:codegen") public final class CommandExecutionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CommandExecutionSummary.Builder,CommandExecutionSummary>

Summary information about a particular command execution.

See Also:

  • Method Details

    • commandArn

      public final String commandArn()

      The Amazon Resource Name (ARN) of the command execution.

      Returns:
      The Amazon Resource Name (ARN) of the command execution.

    • executionId

      public final String executionId()

      The unique identifier of the command execution.

      Returns:
      The unique identifier of the command execution.

    • targetArn

      public final String targetArn()

      The Amazon Resource Name (ARN) of the target device for which the command is being executed.

      Returns:
      The Amazon Resource Name (ARN) of the target device for which the command is being executed.

    • status

      public final CommandExecutionStatus status()

      The status of the command executions.

      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 executions.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the command executions.

      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 executions.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time at which the command execution was created for the target device.

      Returns:
      The date and time at which the command execution was created for the target device.

    • startedAt

      public final Instant startedAt()

      The date and time at which the command started executing on the target device.

      Returns:
      The date and time at which the command started executing on the target device.

    • completedAt

      public final Instant completedAt()

      The date and time at which the command completed executing on the target device.

      Returns:
      The date and time at which the command completed executing on the target device.

    • toBuilder

      public CommandExecutionSummary.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<CommandExecutionSummary.Builder,CommandExecutionSummary>
      Returns:
      a builder for type T

    • builder

      public static CommandExecutionSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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