DeviceFilter (AWS Java SDK :: Services :: AWS Device Farm 2.3.2 API)

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`DeviceFilterOperator`	`operator()` The filter operator.
`String`	`operatorAsString()` The filter operator.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeviceFilter.Builder>`	`serializableBuilderClass()`
`DeviceFilter.Builder`	`toBuilder()`
`String`	`toString()`
`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.
    
    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. Valid values are "TRUE" or "FALSE".
    - REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
    - 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".
    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.
    
    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. Valid values are "TRUE" or "FALSE".
    
    REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
    
    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".
    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.
    
    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. Valid values are "TRUE" or "FALSE".
    - REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
    - 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".
    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.
    
    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. Valid values are "TRUE" or "FALSE".
    
    REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
    
    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".
    See Also:
    
    DeviceFilterAttribute
  - operator
```
public DeviceFilterOperator 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.
    If the service returns an enum value that is not available in the current SDK version, operator will return DeviceFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().
    Returns:
    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.
    See Also:
    
    DeviceFilterOperator
  - operatorAsString
```
public String operatorAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, operator will return DeviceFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().
    Returns:
    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.
    See Also:
    
    DeviceFilterOperator
  - 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.
    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
  - 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

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

values

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields