Class GetSuiteRunResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotdeviceadvisor.model.IotDeviceAdvisorResponse
software.amazon.awssdk.services.iotdeviceadvisor.model.GetSuiteRunResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSuiteRunResponse.Builder,GetSuiteRunResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSuiteRunResponse extends IotDeviceAdvisorResponse implements ToCopyableBuilder<GetSuiteRunResponse.Builder,GetSuiteRunResponse>

  • Method Details

    • suiteDefinitionId

      public final String suiteDefinitionId()

      Suite definition ID for the test suite run.

      Returns:
      Suite definition ID for the test suite run.

    • suiteDefinitionVersion

      public final String suiteDefinitionVersion()

      Suite definition version for the test suite run.

      Returns:
      Suite definition version for the test suite run.

    • suiteRunId

      public final String suiteRunId()

      Suite run ID for the test suite run.

      Returns:
      Suite run ID for the test suite run.

    • suiteRunArn

      public final String suiteRunArn()

      The ARN of the suite run.

      Returns:
      The ARN of the suite run.

    • suiteRunConfiguration

      public final SuiteRunConfiguration suiteRunConfiguration()

      Suite run configuration for the test suite run.

      Returns:
      Suite run configuration for the test suite run.

    • testResult

      public final TestResult testResult()

      Test results for the test suite run.

      Returns:
      Test results for the test suite run.

    • startTime

      public final Instant startTime()

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

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

    • endTime

      public final Instant endTime()

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

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

    • status

      public final SuiteRunStatus status()

      Status for the test 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 for the test suite run.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status for the test 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 for the test suite run.
      See Also:

    • errorReason

      public final String errorReason()

      Error reason for any test suite run failure.

      Returns:
      Error reason for any test suite run failure.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags attached to the suite run.

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

      Returns:
      The tags attached to the suite run.

    • toBuilder

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

    • builder

      public static GetSuiteRunResponse.Builder builder()

    • serializableBuilderClass

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