Package software.amazon.awssdk.services.iotdeviceadvisor.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestCaseScenario.Builder

Method Summary

Modifier and Type	Method	Description
static TestCaseScenario.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failure()	Provides test case scenario failure result.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TestCaseScenario.Builder>	serializableBuilderClass()
TestCaseScenarioStatus	status()	Provides the test case scenario status.
String	statusAsString()	Provides the test case scenario status.
String	systemMessage()	Provides test case scenario system messages if any.
String	testCaseScenarioId()	Provides test case scenario ID.
TestCaseScenarioType	testCaseScenarioType()	Provides test case scenario type.
String	testCaseScenarioTypeAsString()	Provides test case scenario type.
TestCaseScenario.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TestCaseScenarioType

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:

TestCaseScenarioType

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:

TestCaseScenarioStatus

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:

TestCaseScenarioStatus

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

Specified by:

toBuilder in interface ToCopyableBuilder<TestCaseScenario.Builder,TestCaseScenario>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo