Package software.amazon.awssdk.services.devicefarm.model

Interface Run.Builder

    • Method Detail

      • 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

        • 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

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

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

      • type

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

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

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

      • 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:
        DevicePlatform, DevicePlatform

      • 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:
        DevicePlatform, DevicePlatform

      • 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:
        ExecutionStatus, ExecutionStatus

      • 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:
        ExecutionStatus, ExecutionStatus

      • 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:
        ExecutionResult, ExecutionResult

      • 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:
        ExecutionResult, ExecutionResult

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

      • 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, BillingMethod

      • 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:
        BillingMethod, BillingMethod

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

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

      • 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:
        ExecutionResultCode, ExecutionResultCode

      • 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:
        ExecutionResultCode, ExecutionResultCode

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

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

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

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

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