Class SuiteRunInformation

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

Information about the suite run.

Requires permission to access the SuiteRunInformation action.

See Also:

  • Method Details

    • suiteDefinitionId

      public final String suiteDefinitionId()

      Suite definition ID of the suite run.

      Returns:
      Suite definition ID of the suite run.

    • suiteDefinitionVersion

      public final String suiteDefinitionVersion()

      Suite definition version of the suite run.

      Returns:
      Suite definition version of the suite run.

    • suiteDefinitionName

      public final String suiteDefinitionName()

      Suite definition name of the suite run.

      Returns:
      Suite definition name of the suite run.

    • suiteRunId

      public final String suiteRunId()

      Suite run ID of the suite run.

      Returns:
      Suite run ID of the suite run.

    • createdAt

      public final Instant createdAt()

      Date (in Unix epoch time) when the suite run was created.

      Returns:
      Date (in Unix epoch time) when the suite run was created.

    • startedAt

      public final Instant startedAt()

      Date (in Unix epoch time) when the suite run was started.

      Returns:
      Date (in Unix epoch time) when the suite run was started.

    • endAt

      public final Instant endAt()

      Date (in Unix epoch time) when the suite run ended.

      Returns:
      Date (in Unix epoch time) when the suite run ended.

    • status

      public final SuiteRunStatus status()

      Status of the suite run.

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

      Returns:
      Status of the suite run.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the suite run.

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

      Returns:
      Status of the suite run.
      See Also:

    • passed

      public final Integer passed()

      Number of test cases that passed in the suite run.

      Returns:
      Number of test cases that passed in the suite run.

    • failed

      public final Integer failed()

      Number of test cases that failed in the suite run.

      Returns:
      Number of test cases that failed in the suite run.

    • toBuilder

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

    • builder

      public static SuiteRunInformation.Builder builder()

    • serializableBuilderClass

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