com.amazonaws.services.devicefarm.model

Class ListDevicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.devicefarm.model.ListDevicesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the result of a list devices request.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListDevicesRequest()

Method Summary

Modifier and Type	Method and Description
ListDevicesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getArn() The Amazon Resource Name (ARN) of the project.
List<DeviceFilter>	getFilters() Used to select a set of devices.
String	getNextToken() An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
int	hashCode()
void	setArn(String arn) The Amazon Resource Name (ARN) of the project.
void	setFilters(Collection<DeviceFilter> filters) Used to select a set of devices.
void	setNextToken(String nextToken) An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String	toString() Returns a string representation of this object.
ListDevicesRequest	withArn(String arn) The Amazon Resource Name (ARN) of the project.
ListDevicesRequest	withFilters(Collection<DeviceFilter> filters) Used to select a set of devices.
ListDevicesRequest	withFilters(DeviceFilter... filters) Used to select a set of devices.
ListDevicesRequest	withNextToken(String nextToken) An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListDevicesRequest

public ListDevicesRequest()

Method Detail

setArn

public void setArn(String arn)

The Amazon Resource Name (ARN) of the project.

Parameters:

arn - The Amazon Resource Name (ARN) of the project.

getArn

public String getArn()

The Amazon Resource Name (ARN) of the project.

Returns:

The Amazon Resource Name (ARN) of the project.

withArn

public ListDevicesRequest withArn(String arn)

The Amazon Resource Name (ARN) of the project.

Parameters:

arn - The Amazon Resource Name (ARN) of the project.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Parameters:

nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

getNextToken

public String getNextToken()

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

withNextToken

public ListDevicesRequest withNextToken(String nextToken)

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Parameters:

nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

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

getFilters

public List<DeviceFilter> getFilters()

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

Returns:

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

setFilters

public void setFilters(Collection<DeviceFilter> filters)

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

Parameters:

filters - Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

withFilters

public ListDevicesRequest withFilters(DeviceFilter... filters)

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

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

Parameters:

filters - Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

Returns:

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

withFilters

public ListDevicesRequest withFilters(Collection<DeviceFilter> filters)

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

Parameters:

filters - Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

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

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

• Values: An array of one or more filter values.

  • The IN and NOT_IN operators take a values array that has one or more elements.

  • The other operators require an array with a single element.

  • In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

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 ListDevicesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()