Interface Job.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Job.Builder,Job>, SdkBuilder<Job.Builder,Job>, SdkPojo
Enclosing class:
Job

public static interface Job.Builder extends SdkPojo, CopyableBuilder<Job.Builder,Job>
  • Method Details

    • arn

      Job.Builder arn(String arn)

      The job's ARN.

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

      Job.Builder name(String name)

      The job's name.

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

      Job.Builder type(String type)

      The job's type.

      Allowed values include the following:

      • 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 job's type.

      Allowed values include the following:

      • 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:
    • type

      Job.Builder type(TestType type)

      The job's type.

      Allowed values include the following:

      • 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 job's type.

      Allowed values include the following:

      • 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:
    • created

      Job.Builder created(Instant created)

      When the job was created.

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

      Job.Builder status(String status)

      The job's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Parameters:
      status - The job'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

      Job.Builder status(ExecutionStatus status)

      The job's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      Parameters:
      status - The job'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

      Job.Builder result(String result)

      The job's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Parameters:
      result - The job'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

      Job.Builder result(ExecutionResult result)

      The job's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      Parameters:
      result - The job'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

      Job.Builder started(Instant started)

      The job's start time.

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

      Job.Builder stopped(Instant stopped)

      The job's stop time.

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

      Job.Builder counters(Counters counters)

      The job's result counters.

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

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

      The job'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

      Job.Builder message(String message)

      A message about the job's result.

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

      Job.Builder device(Device device)

      The device (phone or tablet).

      Parameters:
      device - The device (phone or tablet).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • device

      default Job.Builder device(Consumer<Device.Builder> device)

      The device (phone or tablet).

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

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

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

      Job.Builder instanceArn(String instanceArn)

      The ARN of the instance.

      Parameters:
      instanceArn - The ARN of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • deviceMinutes

      Job.Builder deviceMinutes(DeviceMinutes deviceMinutes)

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

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

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

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

      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:
    • videoEndpoint

      Job.Builder videoEndpoint(String videoEndpoint)

      The endpoint for streaming device video.

      Parameters:
      videoEndpoint - The endpoint for streaming device video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • videoCapture

      Job.Builder videoCapture(Boolean videoCapture)

      This value is set to true if video capture is enabled. Otherwise, it is set to false.

      Parameters:
      videoCapture - This value is set to true if video capture is enabled. Otherwise, it is set to false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.