software.amazon.awssdk.services.devicefarm.model

Class DeviceSelectionConfiguration

java.lang.Object

software.amazon.awssdk.services.devicefarm.model.DeviceSelectionConfiguration

All Implemented Interfaces:

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

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

Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceSelectionConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static DeviceSelectionConfiguration.Builder	builder()
boolean	equals(Object obj)
List<DeviceFilter>	filters() Used to dynamically select a set of devices for a test run.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxDevices() The maximum number of devices to be included in a test run.
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceSelectionConfiguration.Builder>	serializableBuilderClass()
DeviceSelectionConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

filters

public List<DeviceFilter> filters()

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

• Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

  Allowed values include:

  • ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".

  • PLATFORM: The device platform. Valid values are "ANDROID" or "IOS".

  • OS_VERSION: The operating system version. For example, "10.3.2".

  • MODEL: The device model. For example, "iPad 5th Gen".

  • AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

  • FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET".

  • MANUFACTURER: The device manufacturer. For example, "Apple".

  • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.

  • INSTANCE_LABELS: The label of the device instance.

  • FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE".

• Operator: The filter operator.

  • The EQUALS operator is available for every attribute except INSTANCE_LABELS.

  • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

  • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.

  • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

• Values: An array of one or more filter values.

  • The IN and NOT operators can take a values array that has more than one element.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

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

Returns:

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

• Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

  Allowed values include:

  • ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".

  • PLATFORM: The device platform. Valid values are "ANDROID" or "IOS".

  • OS_VERSION: The operating system version. For example, "10.3.2".

  • MODEL: The device model. For example, "iPad 5th Gen".

  • AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

  • FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET".

  • MANUFACTURER: The device manufacturer. For example, "Apple".

  • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.

  • INSTANCE_LABELS: The label of the device instance.

  • FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE".

• Operator: The filter operator.

  • The EQUALS operator is available for every attribute except INSTANCE_LABELS.

  • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

  • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.

  • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

• Values: An array of one or more filter values.

  • The IN and NOT operators can take a values array that has more than one element.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

maxDevices

public Integer maxDevices()

The maximum number of devices to be included in a test run.

Returns:

The maximum number of devices to be included in a test run.

toBuilder

public DeviceSelectionConfiguration.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<DeviceSelectionConfiguration.Builder,DeviceSelectionConfiguration>

Returns:

a builder for type T

builder

public static DeviceSelectionConfiguration.Builder builder()

serializableBuilderClass

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