Interface Run.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Run.Builder,Run>, SdkBuilder<Run.Builder,Run>, SdkPojo
Enclosing class:
Run
@Mutable @NotThreadSafe public static interface Run.Builder extends SdkPojo, CopyableBuilder<Run.Builder,Run>

  • Method Details

    • arn

      Run.Builder arn(String arn)

      The run's ARN.

      Parameters:
      arn - The run's ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Run.Builder name(String name)

      The run's name.

      Parameters:
      name - The run's name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      Run.Builder type(String 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      Run.Builder type(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      Run.Builder platform(String platform)

      The run's platform.

      Allowed values include:

      • ANDROID

      • IOS

      Parameters:
      platform - The run's platform.

      Allowed values include:

      • ANDROID

      • IOS

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      Run.Builder platform(DevicePlatform platform)

      The run's platform.

      Allowed values include:

      • ANDROID

      • IOS

      Parameters:
      platform - The run's platform.

      Allowed values include:

      • ANDROID

      • IOS

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • created

      Run.Builder created(Instant created)

      When the run was created.

      Parameters:
      created - When the run was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Run.Builder status(String status)

      The run's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Parameters:
      status - The run's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Run.Builder status(ExecutionStatus status)

      The run's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Parameters:
      status - The run's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • result

      Run.Builder result(String result)

      The run's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Parameters:
      result - The run's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • result

      Run.Builder result(ExecutionResult result)

      The run's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Parameters:
      result - The run's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • started

      Run.Builder started(Instant started)

      The run's start time.

      Parameters:
      started - The run's start time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stopped

      Run.Builder stopped(Instant stopped)

      The run's stop time.

      Parameters:
      stopped - The run's stop time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • counters

      Run.Builder counters(Counters counters)

      The run's result counters.

      Parameters:
      counters - The run's result counters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • counters

      default Run.Builder counters(Consumer<Counters.Builder> counters)

      The run's result counters.

      This is a convenience method that creates an instance of the Counters.Builder avoiding the need to create one manually via Counters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to counters(Counters).

      Parameters:
      counters - a consumer that will call methods on Counters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      Run.Builder message(String message)

      A message about the run's result.

      Parameters:
      message - A message about the run's result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalJobs

      Run.Builder totalJobs(Integer totalJobs)

      The total number of jobs for the run.

      Parameters:
      totalJobs - The total number of jobs for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedJobs

      Run.Builder completedJobs(Integer completedJobs)

      The total number of completed jobs.

      Parameters:
      completedJobs - The total number of completed jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • billingMethod

      Run.Builder billingMethod(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • billingMethod

      Run.Builder billingMethod(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceMinutes

      Run.Builder deviceMinutes(DeviceMinutes deviceMinutes)

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

      Parameters:
      deviceMinutes - Represents the total (metered or unmetered) minutes used by the test run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceMinutes

      default Run.Builder deviceMinutes(Consumer<DeviceMinutes.Builder> deviceMinutes)

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

      This is a convenience method that creates an instance of the DeviceMinutes.Builder avoiding the need to create one manually via DeviceMinutes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceMinutes(DeviceMinutes).

      Parameters:
      deviceMinutes - a consumer that will call methods on DeviceMinutes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkProfile

      Run.Builder networkProfile(NetworkProfile networkProfile)

      The network profile being used for a test run.

      Parameters:
      networkProfile - The network profile being used for a test run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkProfile

      default Run.Builder networkProfile(Consumer<NetworkProfile.Builder> networkProfile)

      The network profile being used for a test run.

      This is a convenience method that creates an instance of the NetworkProfile.Builder avoiding the need to create one manually via NetworkProfile.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkProfile(NetworkProfile).

      Parameters:
      networkProfile - a consumer that will call methods on NetworkProfile.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceProxy

      Run.Builder deviceProxy(DeviceProxy deviceProxy)

      The device proxy configured for the devices in the run.

      Parameters:
      deviceProxy - The device proxy configured for the devices in the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceProxy

      default Run.Builder deviceProxy(Consumer<DeviceProxy.Builder> deviceProxy)

      The device proxy configured for the devices in the run.

      This is a convenience method that creates an instance of the DeviceProxy.Builder avoiding the need to create one manually via DeviceProxy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceProxy(DeviceProxy).

      Parameters:
      deviceProxy - a consumer that will call methods on DeviceProxy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parsingResultUrl

      Run.Builder parsingResultUrl(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resultCode

      Run.Builder resultCode(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resultCode

      Run.Builder resultCode(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • seed

      Run.Builder seed(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • appUpload

      Run.Builder appUpload(String appUpload)

      An app to upload or that has been uploaded.

      Parameters:
      appUpload - An app to upload or that has been uploaded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventCount

      Run.Builder eventCount(Integer eventCount)

      For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

      Parameters:
      eventCount - For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobTimeoutMinutes

      Run.Builder jobTimeoutMinutes(Integer jobTimeoutMinutes)

      The number of minutes the job executes before it times out.

      Parameters:
      jobTimeoutMinutes - The number of minutes the job executes before it times out.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • devicePoolArn

      Run.Builder devicePoolArn(String devicePoolArn)

      The ARN of the device pool for the run.

      Parameters:
      devicePoolArn - The ARN of the device pool for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      Run.Builder locale(String locale)

      Information about the locale that is used for the run.

      Parameters:
      locale - Information about the locale that is used for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • radios

      Run.Builder radios(Radios radios)

      Information about the radio states for the run.

      Parameters:
      radios - Information about the radio states for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • radios

      default Run.Builder radios(Consumer<Radios.Builder> radios)

      Information about the radio states for the run.

      This is a convenience method that creates an instance of the Radios.Builder avoiding the need to create one manually via Radios.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to radios(Radios).

      Parameters:
      radios - a consumer that will call methods on Radios.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • location

      Run.Builder location(Location location)

      Information about the location that is used for the run.

      Parameters:
      location - Information about the location that is used for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default Run.Builder location(Consumer<Location.Builder> location)

      Information about the location that is used for the run.

      This is a convenience method that creates an instance of the Location.Builder avoiding the need to create one manually via Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(Location).

      Parameters:
      location - a consumer that will call methods on Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerArtifactPaths

      Run.Builder customerArtifactPaths(CustomerArtifactPaths customerArtifactPaths)

      Output CustomerArtifactPaths object for the test run.

      Parameters:
      customerArtifactPaths - Output CustomerArtifactPaths object for the test run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerArtifactPaths

      default Run.Builder customerArtifactPaths(Consumer<CustomerArtifactPaths.Builder> customerArtifactPaths)

      Output CustomerArtifactPaths object for the test run.

      This is a convenience method that creates an instance of the CustomerArtifactPaths.Builder avoiding the need to create one manually via CustomerArtifactPaths.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customerArtifactPaths(CustomerArtifactPaths).

      Parameters:
      customerArtifactPaths - a consumer that will call methods on CustomerArtifactPaths.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • webUrl

      Run.Builder webUrl(String webUrl)

      The Device Farm console URL for the recording of the run.

      Parameters:
      webUrl - The Device Farm console URL for the recording of the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • skipAppResign

      Run.Builder skipAppResign(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • testSpecArn

      Run.Builder testSpecArn(String testSpecArn)

      The ARN of the YAML-formatted test specification for the run.

      Parameters:
      testSpecArn - The ARN of the YAML-formatted test specification for the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceSelectionResult

      Run.Builder deviceSelectionResult(DeviceSelectionResult deviceSelectionResult)

      The results of a device filter used to select the devices for a test run.

      Parameters:
      deviceSelectionResult - The results of a device filter used to select the devices for a test run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceSelectionResult

      default Run.Builder deviceSelectionResult(Consumer<DeviceSelectionResult.Builder> deviceSelectionResult)

      The results of a device filter used to select the devices for a test run.

      This is a convenience method that creates an instance of the DeviceSelectionResult.Builder avoiding the need to create one manually via DeviceSelectionResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceSelectionResult(DeviceSelectionResult).

      Parameters:
      deviceSelectionResult - a consumer that will call methods on DeviceSelectionResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      Run.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC security groups and subnets that are attached to a project.

      Parameters:
      vpcConfig - The VPC security groups and subnets that are attached to a project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default Run.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC security groups and subnets that are attached to a project.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: