software.amazon.awssdk.services.alexaforbusiness.model

Class SearchDevicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest

software.amazon.awssdk.services.alexaforbusiness.model.SearchDevicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchDevicesRequest
extends AlexaForBusinessRequest
implements ToCopyableBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchDevicesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchDevicesRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() The filters to use to list a specified set of devices.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of results to include in the response.
String	nextToken() An optional token returned from a prior request.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchDevicesRequest.Builder>	serializableBuilderClass()
List<Sort>	sortCriteria() The sort order to use in listing the specified set of devices.
SearchDevicesRequest.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

nextToken

public String nextToken()

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

maxResults

public Integer maxResults()

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

filters

public List<Filter> filters()

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).

sortCriteria

public List<Sort> sortCriteria()

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.

toBuilder

public SearchDevicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchDevicesRequest.Builder,SearchDevicesRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static SearchDevicesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchDevicesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo