AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::DeviceFarm::Model::DeviceFilter Class Reference

#include <DeviceFilter.h>

Public Member Functions

 DeviceFilter ()
 
 DeviceFilter (Aws::Utils::Json::JsonView jsonValue)
 
DeviceFilteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const DeviceFilterAttributeGetAttribute () const
 
bool AttributeHasBeenSet () const
 
void SetAttribute (const DeviceFilterAttribute &value)
 
void SetAttribute (DeviceFilterAttribute &&value)
 
DeviceFilterWithAttribute (const DeviceFilterAttribute &value)
 
DeviceFilterWithAttribute (DeviceFilterAttribute &&value)
 
const RuleOperatorGetOperator () const
 
bool OperatorHasBeenSet () const
 
void SetOperator (const RuleOperator &value)
 
void SetOperator (RuleOperator &&value)
 
DeviceFilterWithOperator (const RuleOperator &value)
 
DeviceFilterWithOperator (RuleOperator &&value)
 
const Aws::Vector< Aws::String > & GetValues () const
 
bool ValuesHasBeenSet () const
 
void SetValues (const Aws::Vector< Aws::String > &value)
 
void SetValues (Aws::Vector< Aws::String > &&value)
 
DeviceFilterWithValues (const Aws::Vector< Aws::String > &value)
 
DeviceFilterWithValues (Aws::Vector< Aws::String > &&value)
 
DeviceFilterAddValues (const Aws::String &value)
 
DeviceFilterAddValues (Aws::String &&value)
 
DeviceFilterAddValues (const char *value)
 

Detailed Description

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 Reference

Definition at line 40 of file DeviceFilter.h.

Constructor & Destructor Documentation

◆ DeviceFilter() [1/2]

Aws::DeviceFarm::Model::DeviceFilter::DeviceFilter ( )

◆ DeviceFilter() [2/2]

Aws::DeviceFarm::Model::DeviceFilter::DeviceFilter ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddValues() [1/3]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::AddValues ( const Aws::String value)
inline

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.

Definition at line 423 of file DeviceFilter.h.

◆ AddValues() [2/3]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::AddValues ( Aws::String &&  value)
inline

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.

Definition at line 437 of file DeviceFilter.h.

◆ AddValues() [3/3]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::AddValues ( const char *  value)
inline

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.

Definition at line 451 of file DeviceFilter.h.

◆ AttributeHasBeenSet()

bool Aws::DeviceFarm::Model::DeviceFilter::AttributeHasBeenSet ( ) const
inline

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

Definition at line 127 of file DeviceFilter.h.

◆ GetAttribute()

const DeviceFilterAttribute& Aws::DeviceFarm::Model::DeviceFilter::GetAttribute ( ) const
inline

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

Definition at line 87 of file DeviceFilter.h.

◆ GetOperator()

const RuleOperator& Aws::DeviceFarm::Model::DeviceFilter::GetOperator ( ) const
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 294 of file DeviceFilter.h.

◆ GetValues()

const Aws::Vector<Aws::String>& Aws::DeviceFarm::Model::DeviceFilter::GetValues ( ) const
inline

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.

Definition at line 339 of file DeviceFilter.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DeviceFarm::Model::DeviceFilter::Jsonize ( ) const

◆ operator=()

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OperatorHasBeenSet()

bool Aws::DeviceFarm::Model::DeviceFilter::OperatorHasBeenSet ( ) const
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 300 of file DeviceFilter.h.

◆ SetAttribute() [1/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetAttribute ( const DeviceFilterAttribute value)
inline

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

Definition at line 167 of file DeviceFilter.h.

◆ SetAttribute() [2/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetAttribute ( DeviceFilterAttribute &&  value)
inline

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

Definition at line 207 of file DeviceFilter.h.

◆ SetOperator() [1/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetOperator ( const RuleOperator value)
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 306 of file DeviceFilter.h.

◆ SetOperator() [2/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetOperator ( RuleOperator &&  value)
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 312 of file DeviceFilter.h.

◆ SetValues() [1/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetValues ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 367 of file DeviceFilter.h.

◆ SetValues() [2/2]

void Aws::DeviceFarm::Model::DeviceFilter::SetValues ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 381 of file DeviceFilter.h.

◆ ValuesHasBeenSet()

bool Aws::DeviceFarm::Model::DeviceFilter::ValuesHasBeenSet ( ) const
inline

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.

Definition at line 353 of file DeviceFilter.h.

◆ WithAttribute() [1/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithAttribute ( const DeviceFilterAttribute value)
inline

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

Definition at line 247 of file DeviceFilter.h.

◆ WithAttribute() [2/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithAttribute ( DeviceFilterAttribute &&  value)
inline

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

Definition at line 287 of file DeviceFilter.h.

◆ WithOperator() [1/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithOperator ( const RuleOperator value)
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 318 of file DeviceFilter.h.

◆ WithOperator() [2/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithOperator ( RuleOperator &&  value)
inline

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Definition at line 324 of file DeviceFilter.h.

◆ WithValues() [1/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithValues ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 395 of file DeviceFilter.h.

◆ WithValues() [2/2]

DeviceFilter& Aws::DeviceFarm::Model::DeviceFilter::WithValues ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 409 of file DeviceFilter.h.


The documentation for this class was generated from the following file: