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

Class Job

java.lang.Object
software.amazon.awssdk.services.devicefarm.model.Job
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>
@Generated("software.amazon.awssdk:codegen") public final class Job extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

Represents a device.

See Also:

  • Method Details

    • arn

      public final String arn()

      The job's ARN.

      Returns:
      The job's ARN.

    • name

      public final String name()

      The job's name.

      Returns:
      The job's name.

    • type

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

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

      See Also:

    • typeAsString

      public final String typeAsString()

      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

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

      See Also:

    • created

      public final Instant created()

      When the job was created.

      Returns:
      When the job was created.

    • status

      public final ExecutionStatus status()

      The job'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 job's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      See Also:

    • statusAsString

      public final String statusAsString()

      The job'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 job's status.

      Allowed values include:

      • PENDING

      • PENDING_CONCURRENCY

      • PENDING_DEVICE

      • PROCESSING

      • SCHEDULING

      • PREPARING

      • RUNNING

      • COMPLETED

      • STOPPING

      See Also:

    • result

      public final ExecutionResult result()

      The job'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 job's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      See Also:

    • resultAsString

      public final String resultAsString()

      The job'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 job's result.

      Allowed values include:

      • PENDING

      • PASSED

      • WARNED

      • FAILED

      • SKIPPED

      • ERRORED

      • STOPPED

      See Also:

    • started

      public final Instant started()

      The job's start time.

      Returns:
      The job's start time.

    • stopped

      public final Instant stopped()

      The job's stop time.

      Returns:
      The job's stop time.

    • counters

      public final Counters counters()

      The job's result counters.

      Returns:
      The job's result counters.

    • message

      public final String message()

      A message about the job's result.

      Returns:
      A message about the job's result.

    • device

      public final Device device()

      The device (phone or tablet).

      Returns:
      The device (phone or tablet).

    • instanceArn

      public final String instanceArn()

      The ARN of the instance.

      Returns:
      The ARN of the instance.

    • deviceMinutes

      public final DeviceMinutes deviceMinutes()

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

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

    • videoEndpoint

      public final String videoEndpoint()

      The endpoint for streaming device video.

      Returns:
      The endpoint for streaming device video.

    • videoCapture

      public final Boolean videoCapture()

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

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

    • toBuilder

      public Job.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<Job.Builder,Job>
      Returns:
      a builder for type T

    • builder

      public static Job.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Job.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.