software.amazon.awssdk.services.devicefarm.model

Class Run

java.lang.Object

software.amazon.awssdk.services.devicefarm.model.Run

All Implemented Interfaces:

StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<Run.Builder,Run>

@Generated(value="software.amazon.awssdk:codegen")
public class Run
extends Object
implements StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<Run.Builder,Run>

Represents an app on a set of devices with a specific test and configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Run.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The run's ARN.
BillingMethod	billingMethod() Specifies the billing method for a test run: metered or unmetered.
String	billingMethodString() Specifies the billing method for a test run: metered or unmetered.
static Run.Builder	builder()
Integer	completedJobs() The total number of completed jobs.
Counters	counters() The run's result counters.
Instant	created() When the run was created.
DeviceMinutes	deviceMinutes() Represents the total (metered or unmetered) minutes used by the test run.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
String	message() A message about the run's result.
String	name() The run's name.
NetworkProfile	networkProfile() The network profile being used for a test run.
DevicePlatform	platform() The run's platform.
String	platformString() The run's platform.
ExecutionResult	result() The run's result.
String	resultString() The run's result.
static Class<? extends Run.Builder>	serializableBuilderClass()
Instant	started() The run's start time.
ExecutionStatus	status() The run's status.
String	statusString() The run's status.
Instant	stopped() The run's stop time.
Run.Builder	toBuilder()
String	toString()
Integer	totalJobs() The total number of jobs for the run.
TestType	type() The run's type.
String	typeString() The run's type.

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

arn

public String arn()

The run's ARN.

Returns:

The run's ARN.

name

public String name()

The run's name.

Returns:

The run's name.

type

public TestType type()

The run's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

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

Returns:

The run's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

See Also:

TestType

typeString

public String typeString()

The run's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

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

Returns:

The run's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

See Also:

TestType

platform

public DevicePlatform platform()

The run's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

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

Returns:

The run's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

See Also:

DevicePlatform

platformString

public String platformString()

The run's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

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

Returns:

The run's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

See Also:

DevicePlatform

created

public Instant created()

When the run was created.

Returns:

When the run was created.

status

public ExecutionStatus status()

The run's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

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

Returns:

The run's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

See Also:

ExecutionStatus

statusString

public String statusString()

The run's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

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

Returns:

The run's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

See Also:

ExecutionStatus

result

public ExecutionResult result()

The run's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

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

Returns:

The run's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

See Also:

ExecutionResult

resultString

public String resultString()

The run's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

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

Returns:

The run's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

See Also:

ExecutionResult

started

public Instant started()

The run's start time.

Returns:

The run's start time.

stopped

public Instant stopped()

The run's stop time.

Returns:

The run's stop time.

counters

public Counters counters()

The run's result counters.

Returns:

The run's result counters.

message

public String message()

A message about the run's result.

Returns:

A message about the run's result.

totalJobs

public Integer totalJobs()

The total number of jobs for the run.

Returns:

The total number of jobs for the run.

completedJobs

public Integer completedJobs()

The total number of completed jobs.

Returns:

The total number of completed jobs.

billingMethod

public BillingMethod billingMethod()

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

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

Returns:

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

See Also:

BillingMethod

billingMethodString

public String billingMethodString()

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

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

Returns:

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

See Also:

BillingMethod

deviceMinutes

public DeviceMinutes deviceMinutes()

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

Returns:

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

networkProfile

public NetworkProfile networkProfile()

The network profile being used for a test run.

Returns:

The network profile being used for a test run.

toBuilder

public Run.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<Run.Builder,Run>

builder

public static Run.Builder builder()

serializableBuilderClass

public static Class<? extends Run.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo