software.amazon.awssdk.services.devicefarm.model

Interface ListDevicesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>, DeviceFarmRequest.Builder, SdkBuilder<ListDevicesRequest.Builder,ListDevicesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListDevicesRequest

public static interface ListDevicesRequest.Builder
extends DeviceFarmRequest.Builder, SdkPojo, CopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

Method Summary

Modifier and Type	Method and Description
ListDevicesRequest.Builder	arn(String arn) The Amazon Resource Name (ARN) of the project.
ListDevicesRequest.Builder	filters(Collection<DeviceFilter> filters) Used to select a set of devices.
ListDevicesRequest.Builder	filters(Consumer<DeviceFilter.Builder>... filters) Used to select a set of devices.
ListDevicesRequest.Builder	filters(DeviceFilter... filters) Used to select a set of devices.
ListDevicesRequest.Builder	nextToken(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.
ListDevicesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListDevicesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.devicefarm.model.DeviceFarmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

ListDevicesRequest.Builder arn(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.

nextToken

ListDevicesRequest.Builder nextToken(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.

filters

ListDevicesRequest.Builder filters(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 selction 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.

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • 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 operators can take a values array that has more than one element.

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

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • 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 operators can take a values array that has more than one element.

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

filters

ListDevicesRequest.Builder filters(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 selction 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.

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • 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 operators can take a values array that has more than one element.

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

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • 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 operators can take a values array that has more than one element.

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

filters

ListDevicesRequest.Builder filters(Consumer<DeviceFilter.Builder>... 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 selction 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.

  • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.

  • 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 operators can take a values array that has more than one element.

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

overrideConfiguration

ListDevicesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListDevicesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.