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

Class TestCaseRun

java.lang.Object

software.amazon.awssdk.services.iotdeviceadvisor.model.TestCaseRun

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TestCaseRun.Builder,TestCaseRun>

@Generated("software.amazon.awssdk:codegen")
public final class TestCaseRun
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TestCaseRun.Builder,TestCaseRun>

Provides the test case run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestCaseRun.Builder

Method Summary

Modifier and Type	Method	Description
static TestCaseRun.Builder	builder()
Instant	endTime()	Provides test case run end time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failure()	Provides test case run failure result.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTestScenarios()	For responses, this returns true if the service returned a value for the TestScenarios property.
String	logUrl()	Provides test case run log URL.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TestCaseRun.Builder>	serializableBuilderClass()
Instant	startTime()	Provides test case run start time.
Status	status()	Provides the test case run status.
String	statusAsString()	Provides the test case run status.
String	testCaseDefinitionId()	Provides the test case run definition ID.
String	testCaseDefinitionName()	Provides the test case run definition name.
String	testCaseRunId()	Provides the test case run ID.
List<TestCaseScenario>	testScenarios()	Provides the test scenarios for the test case run.
TestCaseRun.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	warnings()	Provides test case run warnings.

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

testCaseRunId

public final String testCaseRunId()

Provides the test case run ID.

Returns:

Provides the test case run ID.

testCaseDefinitionId

public final String testCaseDefinitionId()

Provides the test case run definition ID.

Returns:

Provides the test case run definition ID.

testCaseDefinitionName

public final String testCaseDefinitionName()

Provides the test case run definition name.

Returns:

Provides the test case run definition name.

status

public final Status status()

Provides the test case run 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 Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Provides the test case run 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:

Status

statusAsString

public final String statusAsString()

Provides the test case run 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 Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Provides the test case run 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:

Status

startTime

public final Instant startTime()

Provides test case run start time.

Returns:

Provides test case run start time.

endTime

public final Instant endTime()

Provides test case run end time.

Returns:

Provides test case run end time.

logUrl

public final String logUrl()

Provides test case run log URL.

Returns:

Provides test case run log URL.

warnings

public final String warnings()

Provides test case run warnings.

Returns:

Provides test case run warnings.

failure

public final String failure()

Provides test case run failure result.

Returns:

Provides test case run failure result.

hasTestScenarios

public final boolean hasTestScenarios()

For responses, this returns true if the service returned a value for the TestScenarios 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.

testScenarios

public final List<TestCaseScenario> testScenarios()

Provides the test scenarios for the test case 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 hasTestScenarios() method.

Returns:

Provides the test scenarios for the test case run.

toBuilder

public TestCaseRun.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestCaseRun.Builder,TestCaseRun>

builder

public static TestCaseRun.Builder builder()

serializableBuilderClass

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