Package software.amazon.awssdk.services.panorama.model

Class ListDevicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.panorama.model.PanoramaRequest

software.amazon.awssdk.services.panorama.model.ListDevicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListDevicesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListDevicesRequest.Builder	builder()
DeviceAggregatedStatus	deviceAggregatedStatusFilter()	Filter based on a device's status.
String	deviceAggregatedStatusFilterAsString()	Filter based on a device's status.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of devices to return in one page of results.
String	nameFilter()	Filter based on device's name.
String	nextToken()	Specify the pagination token from a previous request to retrieve the next page of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListDevicesRequest.Builder>	serializableBuilderClass()
ListDevicesSortBy	sortBy()	The target column to be sorted on.
String	sortByAsString()	The target column to be sorted on.
SortOrder	sortOrder()	The sorting order for the returned list.
String	sortOrderAsString()	The sorting order for the returned list.
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

deviceAggregatedStatusFilter

public final DeviceAggregatedStatus deviceAggregatedStatusFilter()

Filter based on a device's status.

If the service returns an enum value that is not available in the current SDK version, deviceAggregatedStatusFilter will return DeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceAggregatedStatusFilterAsString().

Returns:

Filter based on a device's status.

See Also:

DeviceAggregatedStatus

deviceAggregatedStatusFilterAsString

public final String deviceAggregatedStatusFilterAsString()

Filter based on a device's status.

If the service returns an enum value that is not available in the current SDK version, deviceAggregatedStatusFilter will return DeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceAggregatedStatusFilterAsString().

Returns:

Filter based on a device's status.

See Also:

DeviceAggregatedStatus

maxResults

public final Integer maxResults()

The maximum number of devices to return in one page of results.

Returns:

The maximum number of devices to return in one page of results.

nameFilter

public final String nameFilter()

Filter based on device's name. Prefixes supported.

Returns:

Filter based on device's name. Prefixes supported.

nextToken

public final String nextToken()

Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

Specify the pagination token from a previous request to retrieve the next page of results.

sortBy

public final ListDevicesSortBy sortBy()

The target column to be sorted on. Default column sort is CREATED_TIME.

If the service returns an enum value that is not available in the current SDK version, sortBy will return ListDevicesSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The target column to be sorted on. Default column sort is CREATED_TIME.

See Also:

ListDevicesSortBy

sortByAsString

public final String sortByAsString()

The target column to be sorted on. Default column sort is CREATED_TIME.

If the service returns an enum value that is not available in the current SDK version, sortBy will return ListDevicesSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The target column to be sorted on. Default column sort is CREATED_TIME.

See Also:

ListDevicesSortBy

sortOrder

public final SortOrder sortOrder()

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

See Also:

SortOrder

toBuilder

public ListDevicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListDevicesRequest.Builder,ListDevicesRequest>

Specified by:

toBuilder in class PanoramaRequest

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo