Package software.amazon.awssdk.services.devicefarm.model

Class ListDevicesRequest

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

Modifier and Type	Method	Description
final String	arn()	The Amazon Resource Name (ARN) of the project.
static ListDevicesRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final List<DeviceFilter>	filters()	Used to select a set of devices.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
final int	hashCode()
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.
final List<SdkField<?>>	sdkFields()
static Class<? extends ListDevicesRequest.Builder>	serializableBuilderClass()
ListDevicesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final 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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

Specified by:

toBuilder in class DeviceFarmRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.