Run (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.devicefarm.model.Run

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Run.Builder,Run>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Run
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Run.Builder,Run>
```
Represents a test run on a set of devices with a given app package, test parameters, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Run.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Run.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appUpload()` An app to upload or that has been uploaded.
`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.
`String`	`devicePoolArn()` The ARN of the device pool for the run.
`DeviceSelectionResult`	`deviceSelectionResult()` The results of a device filter used to select the devices for a test run.
`boolean`	`equals(Object obj)`
`Integer`	`eventCount()` For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`jobTimeoutMinutes()` The number of minutes the job will execute before it times out.
`String`	`locale()` Information about the locale that is used for the run.
`Location`	`location()` Information about the location that is used for the run.
`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.
`Radios`	`radios()` Information about the radio states for the run.
`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.
`List<SdkField<?>>`	`sdkFields()`
`Integer`	`seed()` For fuzz tests, this is a seed to use for randomizing the UI fuzz test.
`static Class<? extends Run.Builder>`	`serializableBuilderClass()`
`Boolean`	`skipAppResign()` When set to `true`, for private devices, Device Farm will not sign your app again.
`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.
`String`	`testSpecArn()` The ARN of the YAML-formatted test specification for the run.
`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.
`String`	`webUrl()` The Device Farm console URL for the recording of the run.

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 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 typeAsString().
    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
  - typeAsString
```
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().
    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 platformAsString().
    Returns:
    The run's platform.
    
    Allowed values include:
    
    ANDROID: The Android platform.
    
    IOS: The iOS platform.
    See Also:
    
    DevicePlatform
  - platformAsString
```
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().
    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 statusAsString().
    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
  - statusAsString
```
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().
    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 resultAsString().
    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
  - resultAsString
```
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().
    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 billingMethodAsString().
    
    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
  - billingMethodAsString
```
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().
    
    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.
  - parsingResultUrl
```
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.
    
    Returns:
    
    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.
  - resultCode
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    ExecutionResultCode
  - resultCodeAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    ExecutionResultCode
  - seed
```
public Integer 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
```
public String appUpload()
```
    An app to upload or that has been uploaded.
    
    Returns:
    
    An app to upload or that has been uploaded.
  - eventCount
```
public Integer 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
```
public Integer jobTimeoutMinutes()
```
    The number of minutes the job will execute before it times out.
    
    Returns:
    
    The number of minutes the job will execute before it times out.
  - devicePoolArn
```
public String devicePoolArn()
```
    The ARN of the device pool for the run.
    
    Returns:
    
    The ARN of the device pool for the run.
  - locale
```
public String locale()
```
    Information about the locale that is used for the run.
    
    Returns:
    
    Information about the locale that is used for the run.
  - radios
```
public Radios radios()
```
    Information about the radio states for the run.
    
    Returns:
    
    Information about the radio states for the run.
  - location
```
public Location location()
```
    Information about the location that is used for the run.
    
    Returns:
    
    Information about the location that is used for the run.
  - customerArtifactPaths
```
public CustomerArtifactPaths customerArtifactPaths()
```
    Output CustomerArtifactPaths object for the test run.
    
    Returns:
    
    Output CustomerArtifactPaths object for the test run.
  - webUrl
```
public String 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
```
public Boolean skipAppResign()
```
    When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
    
    For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
    
    Returns:
    
    When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
    
    For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
  - testSpecArn
```
public String 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
```
public DeviceSelectionResult 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.
  - toBuilder
```
public Run.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<Run.Builder,Run>
    
    Returns:
    
    a builder for type T
  - 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)
```
  - sdkFields
```
public 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.

Class Run

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

type

typeAsString

platform

platformAsString

created

status

statusAsString

result

resultAsString

started

stopped

counters

message

totalJobs

completedJobs

billingMethod

billingMethodAsString

deviceMinutes

networkProfile

parsingResultUrl

resultCode

resultCodeAsString

seed

appUpload

eventCount

jobTimeoutMinutes

devicePoolArn

locale

radios

location

customerArtifactPaths

webUrl

skipAppResign

testSpecArn

deviceSelectionResult

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields