Suite (AWS Java SDK :: Services :: AWS Device Farm 2.14.4 API)

java.lang.Object
- software.amazon.awssdk.services.devicefarm.model.Suite

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Suite.Builder,Suite>

@Generated(value="software.amazon.awssdk:codegen")
public final class Suite
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Suite.Builder,Suite>

Represents a collection of one or more tests.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Suite.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Suite.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The suite's ARN.
`static Suite.Builder`	`builder()`
`Counters`	`counters()` The suite's result counters.
`Instant`	`created()` When the suite was created.
`DeviceMinutes`	`deviceMinutes()` Represents the total (metered or unmetered) minutes used by the test suite.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`message()` A message about the suite's result.
`String`	`name()` The suite's name.
`ExecutionResult`	`result()` The suite's result.
`String`	`resultAsString()` The suite's result.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Suite.Builder>`	`serializableBuilderClass()`
`Instant`	`started()` The suite's start time.
`ExecutionStatus`	`status()` The suite's status.
`String`	`statusAsString()` The suite's status.
`Instant`	`stopped()` The suite's stop time.
`Suite.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TestType`	`type()` The suite's type.
`String`	`typeAsString()` The suite's type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public String arn()
```
    The suite's ARN.
    
    Returns:
    
    The suite's ARN.
  - name
```
public String name()
```
    The suite's name.
    
    Returns:
    
    The suite's name.
  - type
```
public 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 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 Instant created()
```
    When the suite was created.
    
    Returns:
    
    When the suite was created.
  - status
```
public 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 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 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 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 Instant started()
```
    The suite's start time.
    
    Returns:
    
    The suite's start time.
  - stopped
```
public Instant stopped()
```
    The suite's stop time.
    
    Returns:
    
    The suite's stop time.
  - counters
```
public Counters counters()
```
    The suite's result counters.
    
    Returns:
    
    The suite's result counters.
  - message
```
public String message()
```
    A message about the suite's result.
    
    Returns:
    
    A message about the suite's result.
  - deviceMinutes
```
public 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.
  - toBuilder
```
public Suite.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Suite.Builder,Suite>
  - builder
```
public static Suite.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Suite.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Suite

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

name

type

typeAsString

created

status

statusAsString

result

resultAsString

started

stopped

counters

message

deviceMinutes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields