Class TestCaseScenario

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

Provides test case scenario.

See Also:

  • Method Details

    • testCaseScenarioId

      public final String testCaseScenarioId()

      Provides test case scenario ID.

      Returns:
      Provides test case scenario ID.

    • testCaseScenarioType

      public final TestCaseScenarioType testCaseScenarioType()

      Provides test case scenario type. Type is one of the following:

      • Advanced

      • Basic

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

      Returns:
      Provides test case scenario type. Type is one of the following:

      • Advanced

      • Basic

      See Also:

    • testCaseScenarioTypeAsString

      public final String testCaseScenarioTypeAsString()

      Provides test case scenario type. Type is one of the following:

      • Advanced

      • Basic

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

      Returns:
      Provides test case scenario type. Type is one of the following:

      • Advanced

      • Basic

      See Also:

    • status

      public final TestCaseScenarioStatus status()

      Provides the test case scenario status. Status is one of the following:

      • PASS: Test passed.

      • FAIL: Test failed.

      • PENDING: Test has not started running but is scheduled.

      • RUNNING: Test is running.

      • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

      • STOPPED Test is stopped. You will see this status only if you stop a suite run.

      • PASS_WITH_WARNINGS: Test passed with warnings.

      • ERORR: Test faced an error when running due to an internal issue.

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

      Returns:
      Provides the test case scenario status. Status is one of the following:

      • PASS: Test passed.

      • FAIL: Test failed.

      • PENDING: Test has not started running but is scheduled.

      • RUNNING: Test is running.

      • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

      • STOPPED Test is stopped. You will see this status only if you stop a suite run.

      • PASS_WITH_WARNINGS: Test passed with warnings.

      • ERORR: Test faced an error when running due to an internal issue.

      See Also:

    • statusAsString

      public final String statusAsString()

      Provides the test case scenario status. Status is one of the following:

      • PASS: Test passed.

      • FAIL: Test failed.

      • PENDING: Test has not started running but is scheduled.

      • RUNNING: Test is running.

      • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

      • STOPPED Test is stopped. You will see this status only if you stop a suite run.

      • PASS_WITH_WARNINGS: Test passed with warnings.

      • ERORR: Test faced an error when running due to an internal issue.

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

      Returns:
      Provides the test case scenario status. Status is one of the following:

      • PASS: Test passed.

      • FAIL: Test failed.

      • PENDING: Test has not started running but is scheduled.

      • RUNNING: Test is running.

      • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

      • STOPPED Test is stopped. You will see this status only if you stop a suite run.

      • PASS_WITH_WARNINGS: Test passed with warnings.

      • ERORR: Test faced an error when running due to an internal issue.

      See Also:

    • failure

      public final String failure()

      Provides test case scenario failure result.

      Returns:
      Provides test case scenario failure result.

    • systemMessage

      public final String systemMessage()

      Provides test case scenario system messages if any.

      Returns:
      Provides test case scenario system messages if any.

    • toBuilder

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

    • builder

      public static TestCaseScenario.Builder builder()

    • serializableBuilderClass

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