java.lang.Object
- software.amazon.awssdk.services.devicefarm.model.DeviceFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeviceFilter.Builder,DeviceFilter>
```
@Generated("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 Description

static interface DeviceFilter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`	For responses, this returns true if the service returned a value for the Values property.
`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 final 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
    
    Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
    
    Supported operators: EQUALS
    
    Because remote debugging is no longer supported, this filter is ignored.
    
    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
    
    Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
    
    Supported operators: EQUALS
    
    Because remote debugging is no longer supported, this filter is ignored.
    
    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 final 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
    
    Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
    
    Supported operators: EQUALS
    
    Because remote debugging is no longer supported, this filter is ignored.
    
    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
    
    Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
    
    Supported operators: EQUALS
    
    Because remote debugging is no longer supported, this filter is ignored.
    
    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 final RuleOperator operator()
```
    Specifies how Device Farm compares the filter's attribute to the value. 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. See the attribute descriptions.
    
    See Also:
    
    RuleOperator
  - operatorAsString
```
public final String operatorAsString()
```
    Specifies how Device Farm compares the filter's attribute to the value. 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. See the attribute descriptions.
    
    See Also:
    
    RuleOperator
  - hasValues
```
public final boolean hasValues()
```
    For responses, this returns true if the service returned a value for the Values 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.
  - values
```
public final 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.
    
    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 hasValues() method.
    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 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

Class DeviceFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

attribute

attributeAsString

operator

operatorAsString

hasValues

values

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields