software.amazon.awssdk.services.devicefarm.model

Class DeviceFilter

java.lang.Object

software.amazon.awssdk.services.devicefarm.model.DeviceFilter

All Implemented Interfaces:

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

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

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceFilter.Builder

Method Summary

Modifier and Type	Method and Description
DeviceFilterAttribute	attribute() The aspect of a device such as platform or model used as the selection criteria in a device filter.
String	attributeAsString() The aspect of a device such as platform or model used as the selection criteria in a device filter.
static DeviceFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
RuleOperator	operator() Specifies how Device Farm compares the filter's attribute to the value.
String	operatorAsString() Specifies how Device Farm compares the filter's attribute to the value.
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceFilter.Builder>	serializableBuilderClass()
DeviceFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() An array of one or more filter values used in a device filter.

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

attribute

public DeviceFilterAttribute attribute()

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

The supported operators for each attribute are provided in the following list.

ARN

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

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are "ANDROID" or "IOS".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, "10.3.2".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

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

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

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

Supported operators: EQUALS

FORM_FACTOR

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

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Ignored.Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

INSTANCE_ARN

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

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are "PUBLIC" or "PRIVATE".

Supported operators: EQUALS

If the service returns an enum value that is not available in the current SDK version, attribute will return DeviceFilterAttribute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

Returns:

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

The supported operators for each attribute are provided in the following list.

ARN

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

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are "ANDROID" or "IOS".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, "10.3.2".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

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

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

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

Supported operators: EQUALS

FORM_FACTOR

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

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Ignored.Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

INSTANCE_ARN

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

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are "PUBLIC" or "PRIVATE".

Supported operators: EQUALS

See Also:

DeviceFilterAttribute

attributeAsString

public String attributeAsString()

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

The supported operators for each attribute are provided in the following list.

ARN

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

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are "ANDROID" or "IOS".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, "10.3.2".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

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

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

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

Supported operators: EQUALS

FORM_FACTOR

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

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Ignored.Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

INSTANCE_ARN

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

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are "PUBLIC" or "PRIVATE".

Supported operators: EQUALS

If the service returns an enum value that is not available in the current SDK version, attribute will return DeviceFilterAttribute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

Returns:

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

The supported operators for each attribute are provided in the following list.

ARN

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

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are "ANDROID" or "IOS".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, "10.3.2".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

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

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

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

Supported operators: EQUALS

FORM_FACTOR

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

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Ignored.Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

INSTANCE_ARN

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

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are "PUBLIC" or "PRIVATE".

Supported operators: EQUALS

See Also:

DeviceFilterAttribute

operator

public RuleOperator operator()

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

If the service returns an enum value that is not available in the current SDK version, operator will return RuleOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

See Also:

RuleOperator

operatorAsString

public String operatorAsString()

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

If the service returns an enum value that is not available in the current SDK version, operator will return RuleOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

See Also:

RuleOperator

hasValues

public boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public List<String> values()

An array of one or more filter values used in a device filter.

Operator Values

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

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

Attribute Values

• The PLATFORM attribute can be set to "ANDROID" or "IOS".

• The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

• The FORM_FACTOR attribute can be set to "PHONE" or "TABLET".

• The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".

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

You can use hasValues() to see if a value was sent in this field.

Returns:

An array of one or more filter values used in a device filter.

Operator Values

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

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

Attribute Values

• The PLATFORM attribute can be set to "ANDROID" or "IOS".

• The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

• The FORM_FACTOR attribute can be set to "PHONE" or "TABLET".

• The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".

toBuilder

public DeviceFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeviceFilter.Builder,DeviceFilter>

builder

public static DeviceFilter.Builder builder()

serializableBuilderClass

public static Class<? extends DeviceFilter.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo