software.amazon.awssdk.services.devicefarm.model

Class ScheduleRunTest

java.lang.Object

software.amazon.awssdk.services.devicefarm.model.ScheduleRunTest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduleRunTest.Builder,ScheduleRunTest>

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

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScheduleRunTest.Builder

Method Summary

Modifier and Type	Method and Description
static ScheduleRunTest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filter() The test's filter.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters() For responses, this returns true if the service returned a value for the Parameters property.
Map<String,String>	parameters() The test's parameters, such as test framework parameters and fixture settings.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduleRunTest.Builder>	serializableBuilderClass()
String	testPackageArn() The ARN of the uploaded test to be run.
String	testSpecArn() The ARN of the YAML-formatted test specification.
ScheduleRunTest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TestType	type() The test's type.
String	typeAsString() The test'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

type

public final TestType type()

The test's type.

Must be one of the following values:

• 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 test's type.

Must be one of the following values:

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

TestType

typeAsString

public final String typeAsString()

The test's type.

Must be one of the following values:

• 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 test's type.

Must be one of the following values:

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

TestType

testPackageArn

public final String testPackageArn()

The ARN of the uploaded test to be run.

Returns:

The ARN of the uploaded test to be run.

testSpecArn

public final String testSpecArn()

The ARN of the YAML-formatted test specification.

Returns:

The ARN of the YAML-formatted test specification.

filter

public final String filter()

The test's filter.

Returns:

The test's filter.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameters

public final Map<String,String> parameters()

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

• app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

For Calabash tests:

• profile: A cucumber profile (for example, my_profile_name).

• tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).

For Appium tests (all types):

• appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.

  • latest runs the latest Appium version supported by Device Farm (1.9.1).

  • For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.

  • This behavior is subject to change.

For fuzz tests (Android only):

• event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.

• throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.

• seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

• username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.

• password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.

For Instrumentation:

• filter: A test filter string. Examples:

  • Running a single test case: com.android.abc.Test1

  • Running a single test: com.android.abc.Test1#smoke

  • Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:

• filter: A test filter string. Examples:

  • Running a single test class: LoginTests

  • Running a multiple test classes: LoginTests,SmokeTests

  • Running a single test: LoginTests/testValid

  • Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:

• filter: A test filter string. Examples:

  • Running a single test case: com.android.abc.Test1

  • Running a single test: com.android.abc.Test1#smoke

  • Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

Returns:

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

• app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

For Calabash tests:

• profile: A cucumber profile (for example, my_profile_name).

• tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).

For Appium tests (all types):

• appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.

  • latest runs the latest Appium version supported by Device Farm (1.9.1).

  • For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.

  • This behavior is subject to change.

For fuzz tests (Android only):

• event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.

• throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.

• seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

• username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.

• password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.

For Instrumentation:

• filter: A test filter string. Examples:

  • Running a single test case: com.android.abc.Test1

  • Running a single test: com.android.abc.Test1#smoke

  • Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:

• filter: A test filter string. Examples:

  • Running a single test class: LoginTests

  • Running a multiple test classes: LoginTests,SmokeTests

  • Running a single test: LoginTests/testValid

  • Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:

• filter: A test filter string. Examples:

  • Running a single test case: com.android.abc.Test1

  • Running a single test: com.android.abc.Test1#smoke

  • Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

toBuilder

public ScheduleRunTest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduleRunTest.Builder,ScheduleRunTest>

builder

public static ScheduleRunTest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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