java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.devicefarm.model.DeviceFarmRequest
    - - software.amazon.awssdk.services.devicefarm.model.ListDevicesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListDevicesRequest
extends DeviceFarmRequest
implements ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

Represents the result of a list devices request.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListDevicesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the project.
`static ListDevicesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<DeviceFilter>`	`filters()`	Used to select a set of devices.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListDevicesRequest.Builder>`	`serializableBuilderClass()`
`ListDevicesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the project.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the project.
  - nextToken
```
public final 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.
    
    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.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<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. Because remote debugging is no longer supported, this attribute is ignored.
    
    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 the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    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. Because remote debugging is no longer supported, this attribute is ignored.
    
    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 the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
  - toBuilder
```
public ListDevicesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>
    
    Specified by:
    
    toBuilder in class DeviceFarmRequest
  - builder
```
public static ListDevicesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListDevicesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListDevicesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

nextToken

hasFilters

filters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields