@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.
Constructor and Description |
---|
DeviceFilter() |
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()
Specifies how Device Farm compares the filter's attribute to the value.
|
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)
Specifies how Device Farm compares the filter's attribute to the value.
|
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(RuleOperator operator)
Specifies how Device Farm compares the filter's attribute to the value.
|
DeviceFilter |
withOperator(String operator)
Specifies how Device Farm compares the filter's attribute to the value.
|
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.
|
public void setAttribute(String 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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
DeviceFilterAttribute
public String getAttribute()
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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
The supported operators for each attribute are provided in the following list.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
DeviceFilterAttribute
public DeviceFilter withAttribute(String 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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
DeviceFilterAttribute
public DeviceFilter withAttribute(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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
DeviceFilterAttribute
public void setOperator(String operator)
Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
operator
- Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.RuleOperator
public String getOperator()
Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
RuleOperator
public DeviceFilter withOperator(String operator)
Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
operator
- Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.RuleOperator
public DeviceFilter withOperator(RuleOperator operator)
Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
operator
- Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.RuleOperator
public List<String> getValues()
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.
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.
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_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.
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.
public DeviceFilter withValues(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.
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.
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.
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_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.
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.
public String toString()
toString
in class Object
Object.toString()
public DeviceFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.