Class Suite

    • Method Detail

      • arn

        public final String arn()

        The suite's ARN.

        Returns:
        The suite's ARN.
      • name

        public final String name()

        The suite's name.

        Returns:
        The suite's name.
      • type

        public final TestType type()

        The suite's type.

        Must be one of the following values:

        • BUILTIN_FUZZ

        • BUILTIN_EXPLORER

          Only available 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 suite's type.

        Must be one of the following values:

        • BUILTIN_FUZZ

        • BUILTIN_EXPLORER

          Only available 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:
        TestType
      • typeAsString

        public final String typeAsString()

        The suite's type.

        Must be one of the following values:

        • BUILTIN_FUZZ

        • BUILTIN_EXPLORER

          Only available 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 suite's type.

        Must be one of the following values:

        • BUILTIN_FUZZ

        • BUILTIN_EXPLORER

          Only available 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:
        TestType
      • created

        public final Instant created()

        When the suite was created.

        Returns:
        When the suite was created.
      • status

        public final ExecutionStatus status()

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

        Allowed values include:

        • PENDING

        • PENDING_CONCURRENCY

        • PENDING_DEVICE

        • PROCESSING

        • SCHEDULING

        • PREPARING

        • RUNNING

        • COMPLETED

        • STOPPING

        See Also:
        ExecutionStatus
      • statusAsString

        public final String statusAsString()

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

        Allowed values include:

        • PENDING

        • PENDING_CONCURRENCY

        • PENDING_DEVICE

        • PROCESSING

        • SCHEDULING

        • PREPARING

        • RUNNING

        • COMPLETED

        • STOPPING

        See Also:
        ExecutionStatus
      • result

        public final ExecutionResult result()

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

        Allowed values include:

        • PENDING

        • PASSED

        • WARNED

        • FAILED

        • SKIPPED

        • ERRORED

        • STOPPED

        See Also:
        ExecutionResult
      • resultAsString

        public final String resultAsString()

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

        Allowed values include:

        • PENDING

        • PASSED

        • WARNED

        • FAILED

        • SKIPPED

        • ERRORED

        • STOPPED

        See Also:
        ExecutionResult
      • started

        public final Instant started()

        The suite's start time.

        Returns:
        The suite's start time.
      • stopped

        public final Instant stopped()

        The suite's stop time.

        Returns:
        The suite's stop time.
      • counters

        public final Counters counters()

        The suite's result counters.

        Returns:
        The suite's result counters.
      • message

        public final String message()

        A message about the suite's result.

        Returns:
        A message about the suite's result.
      • deviceMinutes

        public final DeviceMinutes deviceMinutes()

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

        Returns:
        Represents the total (metered or unmetered) minutes used by the test suite.
      • serializableBuilderClass

        public static Class<? extends Suite.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)