Class Run

java.lang.Object
software.amazon.awssdk.services.devicefarm.model.Run
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Run.Builder,Run>
@Generated("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, and so on.

See Also:

  • Method Details

    • arn

      public final String arn()

      The run's ARN.

      Returns:
      The run's ARN.

    • name

      public final String name()

      The run's name.

      Returns:
      The run's name.

    • type

      public final TestType type()

      The run'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 run'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:

    • typeAsString

      public final String typeAsString()

      The run'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 run'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:

    • platform

      public final DevicePlatform 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 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

      • IOS

      See Also:

    • platformAsString

      public final String 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 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

      • IOS

      See Also:

    • created

      public final Instant created()

      When the run was created.

      Returns:
      When the run was created.

    • status

      public final ExecutionStatus 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 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

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      See Also:

    • statusAsString

      public final String 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 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

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      See Also:

    • result

      public final ExecutionResult 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 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

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      See Also:

    • resultAsString

      public final String 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 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

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      See Also:

    • started

      public final Instant started()

      The run's start time.

      Returns:
      The run's start time.

    • stopped

      public final Instant stopped()

      The run's stop time.

      Returns:
      The run's stop time.

    • counters

      public final Counters counters()

      The run's result counters.

      Returns:
      The run's result counters.

    • message

      public final String message()

      A message about the run's result.

      Returns:
      A message about the run's result.

    • totalJobs

      public final Integer totalJobs()

      The total number of jobs for the run.

      Returns:
      The total number of jobs for the run.

    • completedJobs

      public final Integer completedJobs()

      The total number of completed jobs.

      Returns:
      The total number of completed jobs.

    • billingMethod

      public final 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 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 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.

      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

      public final 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 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 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.

      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

      public final 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 final NetworkProfile networkProfile()

      The network profile being used for a test run.

      Returns:
      The network profile being used for a test run.

    • deviceProxy

      public final DeviceProxy deviceProxy()

      The device proxy configured for the devices in the run.

      Returns:
      The device proxy configured for the devices in the run.

    • parsingResultUrl

      public final String 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

      public final 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:

    • resultCodeAsString

      public final 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:

    • seed

      public final 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 final String appUpload()

      An app to upload or that has been uploaded.

      Returns:
      An app to upload or that has been uploaded.

    • eventCount

      public final 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 final Integer 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

      public final String devicePoolArn()

      The ARN of the device pool for the run.

      Returns:
      The ARN of the device pool for the run.

    • locale

      public final 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 final Radios radios()

      Information about the radio states for the run.

      Returns:
      Information about the radio states for the run.

    • location

      public final 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 final CustomerArtifactPaths customerArtifactPaths()

      Output CustomerArtifactPaths object for the test run.

      Returns:
      Output CustomerArtifactPaths object for the test run.

    • webUrl

      public final 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 final Boolean 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

      public final 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 final 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.

    • vpcConfig

      public final VpcConfig 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

      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 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.