ScheduleRunTest (AWS SDK for Java

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScheduleRunTest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`String`	`filter()` The test's filter.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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 that will be run.
`String`	`testSpecArn()` The ARN of the YAML-formatted test specification.
`ScheduleRunTest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`TestType`	`type()` The test's type.
`String`	`typeAsString()` The test's type.

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

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

- Method Detail
  - type
```
public TestType type()
```
    The test'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.
    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: 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
  - typeAsString
```
public String typeAsString()
```
    The test'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.
    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: 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
  - testPackageArn
```
public String testPackageArn()
```
    The ARN of the uploaded test that will be run.
    
    Returns:
    
    The ARN of the uploaded test that will be run.
  - testSpecArn
```
public String testSpecArn()
```
    The ARN of the YAML-formatted test specification.
    
    Returns:
    
    The ARN of the YAML-formatted test specification.
  - filter
```
public String filter()
```
    The test's filter.
    
    Returns:
    
    The test's filter.
  - parameters
```
public 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.7.2", "1.7.1", "1.6.5", "latest", and "default".
      
      “latest” will run the latest Appium version supported by Device Farm (1.7.2).
      
      For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
    - password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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.
    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.7.2", "1.7.1", "1.6.5", "latest", and "default".
    
    “latest” will run the latest Appium version supported by Device Farm (1.7.2).
    
    For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
    
    password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScheduleRunTest.Builder,ScheduleRunTest>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ScheduleRunTest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScheduleRunTest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ScheduleRunTest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

type

typeAsString

testPackageArn

testSpecArn

filter

parameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields