Class Suite

java.lang.Object

com.amazonaws.services.devicefarm.model.Suite

All Implemented Interfaces:

Serializable, Cloneable

public class Suite
extends Object
implements Serializable, Cloneable

Represents a collection of one or more tests.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Suite()

Method Summary

Modifier and Type	Method	Description
Suite	clone()
boolean	equals(Object obj)
String	getArn()	The suite's ARN.
Counters	getCounters()	The suite's result counters.
Date	getCreated()	When the suite was created.
DeviceMinutes	getDeviceMinutes()	Represents the total (metered or unmetered) minutes used by the test suite.
String	getMessage()	A message about the suite's result.
String	getName()	The suite's name.
String	getResult()	The suite's result.
Date	getStarted()	The suite's start time.
String	getStatus()	The suite's status.
Date	getStopped()	The suite's stop time.
String	getType()	The suite's type.
int	hashCode()
void	setArn(String arn)	The suite's ARN.
void	setCounters(Counters counters)	The suite's result counters.
void	setCreated(Date created)	When the suite was created.
void	setDeviceMinutes(DeviceMinutes deviceMinutes)	Represents the total (metered or unmetered) minutes used by the test suite.
void	setMessage(String message)	A message about the suite's result.
void	setName(String name)	The suite's name.
void	setResult(ExecutionResult result)	The suite's result.
void	setResult(String result)	The suite's result.
void	setStarted(Date started)	The suite's start time.
void	setStatus(ExecutionStatus status)	The suite's status.
void	setStatus(String status)	The suite's status.
void	setStopped(Date stopped)	The suite's stop time.
void	setType(TestType type)	The suite's type.
void	setType(String type)	The suite's type.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
Suite	withArn(String arn)	The suite's ARN.
Suite	withCounters(Counters counters)	The suite's result counters.
Suite	withCreated(Date created)	When the suite was created.
Suite	withDeviceMinutes(DeviceMinutes deviceMinutes)	Represents the total (metered or unmetered) minutes used by the test suite.
Suite	withMessage(String message)	A message about the suite's result.
Suite	withName(String name)	The suite's name.
Suite	withResult(ExecutionResult result)	The suite's result.
Suite	withResult(String result)	The suite's result.
Suite	withStarted(Date started)	The suite's start time.
Suite	withStatus(ExecutionStatus status)	The suite's status.
Suite	withStatus(String status)	The suite's status.
Suite	withStopped(Date stopped)	The suite's stop time.
Suite	withType(TestType type)	The suite's type.
Suite	withType(String type)	The suite's type.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Suite

public Suite()

Method Details

setArn

public void setArn(String arn)

The suite's ARN.

Parameters:

arn - The suite's ARN.

getArn

public String getArn()

The suite's ARN.

Returns:

The suite's ARN.

withArn

public Suite withArn(String arn)

The suite's ARN.

Parameters:

arn - The suite's ARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The suite's name.

Parameters:

name - The suite's name.

getName

public String getName()

The suite's name.

Returns:

The suite's name.

withName

public Suite withName(String name)

The suite's name.

Parameters:

name - The suite's name.

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Parameters:

type - The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

See Also:

• TestType

getType

public String getType()

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Returns:

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

See Also:

• TestType

withType

public Suite withType(String type)

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Parameters:

type - The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TestType

setType

public void setType(TestType type)

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Parameters:

type - The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

See Also:

• TestType

withType

public Suite withType(TestType type)

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Parameters:

type - The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ: The built-in fuzz type.

• BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

• APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

• APPIUM_PYTHON: The Appium Python type.

• APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

• APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

• APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

• CALABASH: The Calabash type.

• INSTRUMENTATION: The Instrumentation type.

• UIAUTOMATION: The uiautomation type.

• UIAUTOMATOR: The uiautomator type.

• XCTEST: The XCode test type.

• XCTEST_UI: The XCode UI test type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TestType

setCreated

public void setCreated(Date created)

When the suite was created.

Parameters:

created - When the suite was created.

getCreated

public Date getCreated()

When the suite was created.

Returns:

When the suite was created.

withCreated

public Suite withCreated(Date created)

When the suite was created.

Parameters:

created - When the suite was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Parameters:

status - The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

See Also:

• ExecutionStatus

getStatus

public String getStatus()

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Returns:

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

See Also:

• ExecutionStatus

withStatus

public Suite withStatus(String status)

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Parameters:

status - The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExecutionStatus

setStatus

public void setStatus(ExecutionStatus status)

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Parameters:

status - The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

See Also:

• ExecutionStatus

withStatus

public Suite withStatus(ExecutionStatus status)

The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Parameters:

status - The suite's status.

Allowed values include:

• PENDING: A pending status.

• PENDING_CONCURRENCY: A pending concurrency status.

• PENDING_DEVICE: A pending device status.

• PROCESSING: A processing status.

• SCHEDULING: A scheduling status.

• PREPARING: A preparing status.

• RUNNING: A running status.

• COMPLETED: A completed status.

• STOPPING: A stopping status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExecutionStatus

setResult

public void setResult(String result)

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Parameters:

result - The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

See Also:

• ExecutionResult

getResult

public String getResult()

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Returns:

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

See Also:

• ExecutionResult

withResult

public Suite withResult(String result)

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Parameters:

result - The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExecutionResult

setResult

public void setResult(ExecutionResult result)

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Parameters:

result - The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

See Also:

• ExecutionResult

withResult

public Suite withResult(ExecutionResult result)

The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Parameters:

result - The suite's result.

Allowed values include:

• PENDING: A pending condition.

• PASSED: A passing condition.

• WARNED: A warning condition.

• FAILED: A failed condition.

• SKIPPED: A skipped condition.

• ERRORED: An error condition.

• STOPPED: A stopped condition.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExecutionResult

setStarted

public void setStarted(Date started)

The suite's start time.

Parameters:

started - The suite's start time.

getStarted

public Date getStarted()

The suite's start time.

Returns:

The suite's start time.

withStarted

public Suite withStarted(Date started)

The suite's start time.

Parameters:

started - The suite's start time.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStopped

public void setStopped(Date stopped)

The suite's stop time.

Parameters:

stopped - The suite's stop time.

getStopped

public Date getStopped()

The suite's stop time.

Returns:

The suite's stop time.

withStopped

public Suite withStopped(Date stopped)

The suite's stop time.

Parameters:

stopped - The suite's stop time.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCounters

public void setCounters(Counters counters)

The suite's result counters.

Parameters:

counters - The suite's result counters.

getCounters

public Counters getCounters()

The suite's result counters.

Returns:

The suite's result counters.

withCounters

public Suite withCounters(Counters counters)

The suite's result counters.

Parameters:

counters - The suite's result counters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessage

public void setMessage(String message)

A message about the suite's result.

Parameters:

message - A message about the suite's result.

getMessage

public String getMessage()

A message about the suite's result.

Returns:

A message about the suite's result.

withMessage

public Suite withMessage(String message)

A message about the suite's result.

Parameters:

message - A message about the suite's result.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeviceMinutes

public void setDeviceMinutes(DeviceMinutes deviceMinutes)

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

Parameters:

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

getDeviceMinutes

public DeviceMinutes getDeviceMinutes()

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.

withDeviceMinutes

public Suite withDeviceMinutes(DeviceMinutes deviceMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Suite clone()

Overrides:

clone in class Object