Class Suite

java.lang.Object

software.amazon.awssdk.services.devicefarm.model.Suite

All Implemented Interfaces:

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

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

Represents a collection of one or more tests.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Suite.Builder

Method Summary

Modifier and Type	Method	Description
final String	arn()	The suite's ARN.
static Suite.Builder	builder()
final Counters	counters()	The suite's result counters.
final Instant	created()	When the suite was created.
final DeviceMinutes	deviceMinutes()	Represents the total (metered or unmetered) minutes used by the test suite.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	message()	A message about the suite's result.
final String	name()	The suite's name.
final ExecutionResult	result()	The suite's result.
final String	resultAsString()	The suite's result.
final List<SdkField<?>>	sdkFields()
static Class<? extends Suite.Builder>	serializableBuilderClass()
final Instant	started()	The suite's start time.
final ExecutionStatus	status()	The suite's status.
final String	statusAsString()	The suite's status.
final Instant	stopped()	The suite's stop time.
Suite.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final TestType	type()	The suite's type.
final String	typeAsString()	The suite's type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

arn

public final String arn()

The suite's ARN.

Returns:

The suite's ARN.

name

public final String name()

The suite's name.

Returns:

The suite's name.

type

public final TestType type()

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ

• APPIUM_JAVA_JUNIT

• APPIUM_JAVA_TESTNG

• APPIUM_PYTHON

• APPIUM_NODE

• APPIUM_RUBY

• APPIUM_WEB_JAVA_JUNIT

• APPIUM_WEB_JAVA_TESTNG

• APPIUM_WEB_PYTHON

• APPIUM_WEB_NODE

• APPIUM_WEB_RUBY

• INSTRUMENTATION

• XCTEST

• XCTEST_UI

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

Returns:

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ

• APPIUM_JAVA_JUNIT

• APPIUM_JAVA_TESTNG

• APPIUM_PYTHON

• APPIUM_NODE

• APPIUM_RUBY

• APPIUM_WEB_JAVA_JUNIT

• APPIUM_WEB_JAVA_TESTNG

• APPIUM_WEB_PYTHON

• APPIUM_WEB_NODE

• APPIUM_WEB_RUBY

• INSTRUMENTATION

• XCTEST

• XCTEST_UI

See Also:

• TestType

typeAsString

public final String typeAsString()

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ

• APPIUM_JAVA_JUNIT

• APPIUM_JAVA_TESTNG

• APPIUM_PYTHON

• APPIUM_NODE

• APPIUM_RUBY

• APPIUM_WEB_JAVA_JUNIT

• APPIUM_WEB_JAVA_TESTNG

• APPIUM_WEB_PYTHON

• APPIUM_WEB_NODE

• APPIUM_WEB_RUBY

• INSTRUMENTATION

• XCTEST

• XCTEST_UI

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

Returns:

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ

• APPIUM_JAVA_JUNIT

• APPIUM_JAVA_TESTNG

• APPIUM_PYTHON

• APPIUM_NODE

• APPIUM_RUBY

• APPIUM_WEB_JAVA_JUNIT

• APPIUM_WEB_JAVA_TESTNG

• APPIUM_WEB_PYTHON

• APPIUM_WEB_NODE

• APPIUM_WEB_RUBY

• INSTRUMENTATION

• XCTEST

• XCTEST_UI

See Also:

• TestType

created

public final Instant created()

When the suite was created.

Returns:

When the suite was created.

status

public final ExecutionStatus status()

The suite's status.

Allowed values include:

• PENDING

• PENDING_CONCURRENCY

• PENDING_DEVICE

• PROCESSING

• SCHEDULING

• PREPARING

• RUNNING

• COMPLETED

• STOPPING

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

Returns:

The suite's status.

Allowed values include:

• PENDING

• PENDING_CONCURRENCY

• PENDING_DEVICE

• PROCESSING

• SCHEDULING

• PREPARING

• RUNNING

• COMPLETED

• STOPPING

See Also:

• ExecutionStatus

statusAsString

public final String statusAsString()

The suite's status.

Allowed values include:

• PENDING

• PENDING_CONCURRENCY

• PENDING_DEVICE

• PROCESSING

• SCHEDULING

• PREPARING

• RUNNING

• COMPLETED

• STOPPING

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

Returns:

The suite's status.

Allowed values include:

• PENDING

• PENDING_CONCURRENCY

• PENDING_DEVICE

• PROCESSING

• SCHEDULING

• PREPARING

• RUNNING

• COMPLETED

• STOPPING

See Also:

• ExecutionStatus

result

public final ExecutionResult result()

The suite's result.

Allowed values include:

• PENDING

• PASSED

• WARNED

• FAILED

• SKIPPED

• ERRORED

• STOPPED

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

Returns:

The suite's result.

Allowed values include:

• PENDING

• PASSED

• WARNED

• FAILED

• SKIPPED

• ERRORED

• STOPPED

See Also:

• ExecutionResult

resultAsString

public final String resultAsString()

The suite's result.

Allowed values include:

• PENDING

• PASSED

• WARNED

• FAILED

• SKIPPED

• ERRORED

• STOPPED

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

Returns:

The suite's result.

Allowed values include:

• PENDING

• PASSED

• WARNED

• FAILED

• SKIPPED

• ERRORED

• STOPPED

See Also:

• ExecutionResult

started

public final Instant started()

The suite's start time.

Returns:

The suite's start time.

stopped

public final Instant stopped()

The suite's stop time.

Returns:

The suite's stop time.

counters

public final Counters counters()

The suite's result counters.

Returns:

The suite's result counters.

message

public final String message()

A message about the suite's result.

Returns:

A message about the suite's result.

deviceMinutes

public final DeviceMinutes deviceMinutes()

Represents the total (metered or unmetered) minutes used by the test suite.

Returns:

Represents the total (metered or unmetered) minutes used by the test suite.

toBuilder

public Suite.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<Suite.Builder,Suite>

Returns:

a builder for type T

builder

public static Suite.Builder builder()

serializableBuilderClass

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