Class Run
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Run.Builder,
Run>
Represents a test run on a set of devices with a given app package, test parameters, and so on.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
An app to upload or that has been uploaded.final String
arn()
The run's ARN.final BillingMethod
Specifies the billing method for a test run:metered
orunmetered
.final String
Specifies the billing method for a test run:metered
orunmetered
.static Run.Builder
builder()
final Integer
The total number of completed jobs.final Counters
counters()
The run's result counters.final Instant
created()
When the run was created.final CustomerArtifactPaths
OutputCustomerArtifactPaths
object for the test run.final DeviceMinutes
Represents the total (metered or unmetered) minutes used by the test run.final String
The ARN of the device pool for the run.final DeviceSelectionResult
The results of a device filter used to select the devices for a test run.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The number of minutes the job executes before it times out.final String
locale()
Information about the locale that is used for the run.final Location
location()
Information about the location that is used for the run.final String
message()
A message about the run's result.final String
name()
The run's name.final NetworkProfile
The network profile being used for a test run.final String
Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package.final DevicePlatform
platform()
The run's platform.final String
The run's platform.final Radios
radios()
Information about the radio states for the run.final ExecutionResult
result()
The run's result.final String
The run's result.final ExecutionResultCode
Supporting field for the result field.final String
Supporting field for the result field.final Integer
seed()
For fuzz tests, this is a seed to use for randomizing the UI fuzz test.static Class
<? extends Run.Builder> final Boolean
When set totrue
, for private devices, Device Farm does not sign your app again.final Instant
started()
The run's start time.final ExecutionStatus
status()
The run's status.final String
The run's status.final Instant
stopped()
The run's stop time.final String
The ARN of the YAML-formatted test specification for the run.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 Integer
The total number of jobs for the run.final TestType
type()
The run's type.final String
The run's type.final VpcConfig
The VPC security groups and subnets that are attached to a project.final String
webUrl()
The Device Farm console URL for the recording of the run.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The run's ARN.
- Returns:
- The run's ARN.
-
name
The run's name.
- Returns:
- The run's name.
-
type
The run's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
BUILTIN_EXPLORER
For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
-
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
-
CALABASH
-
INSTRUMENTATION
-
UIAUTOMATION
-
UIAUTOMATOR
-
XCTEST
-
XCTEST_UI
If the service returns an enum value that is not available in the current SDK version,
type
will returnTestType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The run's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
BUILTIN_EXPLORER
For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
-
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
-
CALABASH
-
INSTRUMENTATION
-
UIAUTOMATION
-
UIAUTOMATOR
-
XCTEST
-
XCTEST_UI
-
- See Also:
-
-
typeAsString
The run's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
BUILTIN_EXPLORER
For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
-
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
-
CALABASH
-
INSTRUMENTATION
-
UIAUTOMATION
-
UIAUTOMATOR
-
XCTEST
-
XCTEST_UI
If the service returns an enum value that is not available in the current SDK version,
type
will returnTestType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The run's type.
Must be one of the following values:
-
BUILTIN_FUZZ
-
BUILTIN_EXPLORER
For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
-
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
-
CALABASH
-
INSTRUMENTATION
-
UIAUTOMATION
-
UIAUTOMATOR
-
XCTEST
-
XCTEST_UI
-
- See Also:
-
-
platform
The run's platform.
Allowed values include:
-
ANDROID
-
IOS
If the service returns an enum value that is not available in the current SDK version,
platform
will returnDevicePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The run's platform.
Allowed values include:
-
ANDROID
-
IOS
-
- See Also:
-
-
platformAsString
The run's platform.
Allowed values include:
-
ANDROID
-
IOS
If the service returns an enum value that is not available in the current SDK version,
platform
will returnDevicePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The run's platform.
Allowed values include:
-
ANDROID
-
IOS
-
- See Also:
-
-
created
When the run was created.
- Returns:
- When the run was created.
-
status
The run'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 returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The run's status.
Allowed values include:
-
PENDING
-
PENDING_CONCURRENCY
-
PENDING_DEVICE
-
PROCESSING
-
SCHEDULING
-
PREPARING
-
RUNNING
-
COMPLETED
-
STOPPING
-
- See Also:
-
-
statusAsString
The run'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 returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The run's status.
Allowed values include:
-
PENDING
-
PENDING_CONCURRENCY
-
PENDING_DEVICE
-
PROCESSING
-
SCHEDULING
-
PREPARING
-
RUNNING
-
COMPLETED
-
STOPPING
-
- See Also:
-
-
result
The run'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 returnExecutionResult.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresultAsString()
.- Returns:
- The run's result.
Allowed values include:
-
PENDING
-
PASSED
-
WARNED
-
FAILED
-
SKIPPED
-
ERRORED
-
STOPPED
-
- See Also:
-
-
resultAsString
The run'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 returnExecutionResult.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresultAsString()
.- Returns:
- The run's result.
Allowed values include:
-
PENDING
-
PASSED
-
WARNED
-
FAILED
-
SKIPPED
-
ERRORED
-
STOPPED
-
- See Also:
-
-
started
The run's start time.
- Returns:
- The run's start time.
-
stopped
The run's stop time.
- Returns:
- The run's stop time.
-
counters
The run's result counters.
- Returns:
- The run's result counters.
-
message
A message about the run's result.
- Returns:
- A message about the run's result.
-
totalJobs
The total number of jobs for the run.
- Returns:
- The total number of jobs for the run.
-
completedJobs
The total number of completed jobs.
- Returns:
- The total number of completed jobs.
-
billingMethod
Specifies the billing method for a test run:
metered
orunmetered
. If the parameter is not specified, the default value ismetered
.If you have unmetered device slots, you must set this to
unmetered
to use them. Otherwise, the run is counted toward metered device minutes.If the service returns an enum value that is not available in the current SDK version,
billingMethod
will returnBillingMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombillingMethodAsString()
.- Returns:
- Specifies the billing method for a test run:
metered
orunmetered
. If the parameter is not specified, the default value ismetered
.If you have unmetered device slots, you must set this to
unmetered
to use them. Otherwise, the run is counted toward metered device minutes. - See Also:
-
billingMethodAsString
Specifies the billing method for a test run:
metered
orunmetered
. If the parameter is not specified, the default value ismetered
.If you have unmetered device slots, you must set this to
unmetered
to use them. Otherwise, the run is counted toward metered device minutes.If the service returns an enum value that is not available in the current SDK version,
billingMethod
will returnBillingMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombillingMethodAsString()
.- Returns:
- Specifies the billing method for a test run:
metered
orunmetered
. If the parameter is not specified, the default value ismetered
.If you have unmetered device slots, you must set this to
unmetered
to use them. Otherwise, the run is counted toward metered device minutes. - See Also:
-
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
The network profile being used for a test run.
- Returns:
- The network profile being used for a test run.
-
parsingResultUrl
Read-only URL for an object in an 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.
- Returns:
- Read-only URL for an object in an 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.
-
resultCode
Supporting field for the result field. Set only if
result
isSKIPPED
.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 returnExecutionResultCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresultCodeAsString()
.- Returns:
- Supporting field for the result field. Set only if
result
isSKIPPED
.PARSING_FAILED
if the result is skipped because of test package parsing failure. - See Also:
-
resultCodeAsString
Supporting field for the result field. Set only if
result
isSKIPPED
.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 returnExecutionResultCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresultCodeAsString()
.- Returns:
- Supporting field for the result field. Set only if
result
isSKIPPED
.PARSING_FAILED
if the result is skipped because of test package parsing failure. - See Also:
-
seed
For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
- Returns:
- For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
-
appUpload
An app to upload or that has been uploaded.
- Returns:
- An app to upload or that has been uploaded.
-
eventCount
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
- Returns:
- For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
-
jobTimeoutMinutes
The number of minutes the job executes before it times out.
- Returns:
- The number of minutes the job executes before it times out.
-
devicePoolArn
The ARN of the device pool for the run.
- Returns:
- The ARN of the device pool for the run.
-
locale
Information about the locale that is used for the run.
- Returns:
- Information about the locale that is used for the run.
-
radios
Information about the radio states for the run.
- Returns:
- Information about the radio states for the run.
-
location
Information about the location that is used for the run.
- Returns:
- Information about the location that is used for the run.
-
customerArtifactPaths
Output
CustomerArtifactPaths
object for the test run.- Returns:
- Output
CustomerArtifactPaths
object for the test run.
-
webUrl
The Device Farm console URL for the recording of the run.
- Returns:
- The Device Farm console URL for the recording of the run.
-
skipAppResign
When set to
true
, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
- Returns:
- When set to
true
, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
-
testSpecArn
The ARN of the YAML-formatted test specification for the run.
- Returns:
- The ARN of the YAML-formatted test specification for the run.
-
deviceSelectionResult
The results of a device filter used to select the devices for a test run.
- Returns:
- The results of a device filter used to select the devices for a test run.
-
vpcConfig
The VPC security groups and subnets that are attached to a project.
- Returns:
- The VPC security groups and subnets that are attached to a project.
-
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 interfaceToCopyableBuilder<Run.Builder,
Run> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-