@Generated(value="software.amazon.awssdk:codegen") public final class Run extends Object implements StructuredPojo, ToCopyableBuilder<Run.Builder,Run>
Represents a test run on a set of devices with a given app package, test parameters, etc.
Modifier and Type | Class and Description |
---|---|
static interface |
Run.Builder |
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 |
billingMethodAsString()
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.
|
CustomerArtifactPaths |
customerArtifactPaths()
Output
CustomerArtifactPaths object for the test run. |
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)
Marshalls this structured data using the given
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.
|
String |
parsingResultUrl()
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package.
|
DevicePlatform |
platform()
The run's platform.
|
String |
platformAsString()
The run's platform.
|
ExecutionResult |
result()
The run's result.
|
String |
resultAsString()
The run's result.
|
ExecutionResultCode |
resultCode()
Supporting field for the result field.
|
String |
resultCodeAsString()
Supporting field for the result field.
|
static Class<? extends Run.Builder> |
serializableBuilderClass() |
Instant |
started()
The run's start time.
|
ExecutionStatus |
status()
The run's status.
|
String |
statusAsString()
The run's status.
|
Instant |
stopped()
The run's stop time.
|
Run.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Integer |
totalJobs()
The total number of jobs for the run.
|
TestType |
type()
The run's type.
|
String |
typeAsString()
The run's type.
|
copy
public String arn()
The run's ARN.
public String name()
The run's name.
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
typeAsString()
.
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.
TestType
public String typeAsString()
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
typeAsString()
.
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.
TestType
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
platformAsString()
.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
DevicePlatform
public String platformAsString()
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
platformAsString()
.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
DevicePlatform
public Instant created()
When the run was created.
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
statusAsString()
.
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.
ExecutionStatus
public String statusAsString()
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
statusAsString()
.
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.
ExecutionStatus
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
resultAsString()
.
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.
ExecutionResult
public String resultAsString()
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
resultAsString()
.
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.
ExecutionResult
public Instant started()
The run's start time.
public Instant stopped()
The run's stop time.
public Counters counters()
The run's result counters.
public String message()
A message about the run's result.
public Integer totalJobs()
The total number of jobs for the run.
public Integer completedJobs()
The total number of completed jobs.
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
billingMethodAsString()
.
metered
or unmetered
. If the
parameter is not specified, the default value is metered
.BillingMethod
public String billingMethodAsString()
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
billingMethodAsString()
.
metered
or unmetered
. If the
parameter is not specified, the default value is metered
.BillingMethod
public DeviceMinutes deviceMinutes()
Represents the total (metered or unmetered) minutes used by the test run.
public NetworkProfile networkProfile()
The network profile being used for a test run.
public String parsingResultUrl()
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
public ExecutionResultCode resultCode()
Supporting field for the result field. Set only if result
is SKIPPED
.
PARSING_FAILED
if the result is skipped because of test package parsing failure.
If the service returns an enum value that is not available in the current SDK version, resultCode
will
return ExecutionResultCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from resultCodeAsString()
.
result
is SKIPPED
.
PARSING_FAILED
if the result is skipped because of test package parsing failure.ExecutionResultCode
public String resultCodeAsString()
Supporting field for the result field. Set only if result
is SKIPPED
.
PARSING_FAILED
if the result is skipped because of test package parsing failure.
If the service returns an enum value that is not available in the current SDK version, resultCode
will
return ExecutionResultCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from resultCodeAsString()
.
result
is SKIPPED
.
PARSING_FAILED
if the result is skipped because of test package parsing failure.ExecutionResultCode
public CustomerArtifactPaths customerArtifactPaths()
Output CustomerArtifactPaths
object for the test run.
CustomerArtifactPaths
object for the test run.public Run.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Run.Builder,Run>
public static Run.Builder builder()
public static Class<? extends Run.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.