com.amazonaws.services.devicefarm.model

Class DeviceFilter

java.lang.Object

com.amazonaws.services.devicefarm.model.DeviceFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeviceFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceFilter()

Method Summary

Modifier and Type	Method and Description
DeviceFilter	clone()
boolean	equals(Object obj)
String	getAttribute() The aspect of a device such as platform or model used as the selection criteria in a device filter.
String	getOperator() The filter operator.
List<String>	getValues() An array of one or more filter values used in a device filter.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttribute(String attribute) The aspect of a device such as platform or model used as the selection criteria in a device filter.
void	setOperator(String operator) The filter operator.
void	setValues(Collection<String> values) An array of one or more filter values used in a device filter.
String	toString() Returns a string representation of this object.
DeviceFilter	withAttribute(DeviceFilterAttribute attribute) The aspect of a device such as platform or model used as the selection criteria in a device filter.
DeviceFilter	withAttribute(String attribute) The aspect of a device such as platform or model used as the selection criteria in a device filter.
DeviceFilter	withOperator(DeviceFilterOperator operator) The filter operator.
DeviceFilter	withOperator(String operator) The filter operator.
DeviceFilter	withValues(Collection<String> values) An array of one or more filter values used in a device filter.
DeviceFilter	withValues(String... values) An array of one or more filter values used in a device filter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceFilter

public DeviceFilter()

Method Detail

setAttribute

public void setAttribute(String 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".

Parameters:

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".

See Also:

DeviceFilterAttribute

getAttribute

public String getAttribute()

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".

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.

• 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".

See Also:

DeviceFilterAttribute

withAttribute

public DeviceFilter withAttribute(String 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeviceFilterAttribute

withAttribute

public DeviceFilter withAttribute(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.

• 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeviceFilterAttribute

setOperator

public void setOperator(String 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.

Parameters:

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.

See Also:

DeviceFilterOperator

getOperator

public String getOperator()

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.

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

withOperator

public DeviceFilter withOperator(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeviceFilterOperator

withOperator

public DeviceFilter withOperator(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DeviceFilterOperator

getValues

public List<String> getValues()

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

Operator 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.

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".

Returns:

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

Operator 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.

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".

setValues

public void setValues(Collection<String> values)

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

Operator 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.

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".

Parameters:

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

Operator 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.

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".

withValues

public DeviceFilter withValues(String... values)

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

Operator 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.

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".

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

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

Operator 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.

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public DeviceFilter withValues(Collection<String> values)

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

Operator 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.

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".

Parameters:

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

Operator 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.

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeviceFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.