software.amazon.awssdk.services.devicefarm.model

Interface Suite.Builder

All Superinterfaces:

CopyableBuilder<Suite.Builder,Suite>, SdkBuilder<Suite.Builder,Suite>

Enclosing class:

Suite

public static interface Suite.Builder
extends CopyableBuilder<Suite.Builder,Suite>

Method Summary

Modifier and Type	Method and Description
Suite.Builder	arn(String arn) The suite's ARN.
default Suite.Builder	counters(Consumer<Counters.Builder> counters) The suite's result counters.
Suite.Builder	counters(Counters counters) The suite's result counters.
Suite.Builder	created(Instant created) When the suite was created.
default Suite.Builder	deviceMinutes(Consumer<DeviceMinutes.Builder> deviceMinutes) Represents the total (metered or unmetered) minutes used by the test suite.
Suite.Builder	deviceMinutes(DeviceMinutes deviceMinutes) Represents the total (metered or unmetered) minutes used by the test suite.
Suite.Builder	message(String message) A message about the suite's result.
Suite.Builder	name(String name) The suite's name.
Suite.Builder	result(ExecutionResult result) The suite's result.
Suite.Builder	result(String result) The suite's result.
Suite.Builder	started(Instant started) The suite's start time.
Suite.Builder	status(ExecutionStatus status) The suite's status.
Suite.Builder	status(String status) The suite's status.
Suite.Builder	stopped(Instant stopped) The suite's stop time.
Suite.Builder	type(String type) The suite's type.
Suite.Builder	type(TestType type) The suite's type.

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

copy

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

apply, build

Method Detail

arn

Suite.Builder arn(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.

name

Suite.Builder name(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.

type

Suite.Builder type(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, TestType

type

Suite.Builder type(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, TestType

created

Suite.Builder created(Instant 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.

status

Suite.Builder status(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, ExecutionStatus

status

Suite.Builder status(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, ExecutionStatus

result

Suite.Builder result(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, ExecutionResult

result

Suite.Builder result(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, ExecutionResult

started

Suite.Builder started(Instant 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.

stopped

Suite.Builder stopped(Instant 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.

counters

Suite.Builder counters(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.

counters

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

The suite's result counters.

This is a convenience 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:

counters(Counters)

message

Suite.Builder message(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.

deviceMinutes

Suite.Builder deviceMinutes(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.

deviceMinutes

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

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

This is a convenience 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:

deviceMinutes(DeviceMinutes)