Class ListDevicesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListDevicesRequest.Builder,
ListDevicesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListDevicesRequest.Builder
builder()
final DeviceAggregatedStatus
Filter based on a device's status.final String
Filter based on a device's status.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of devices to return in one page of results.final String
Filter based on device's name.final String
Specify the pagination token from a previous request to retrieve the next page of results.static Class
<? extends ListDevicesRequest.Builder> final ListDevicesSortBy
sortBy()
The target column to be sorted on.final String
The target column to be sorted on.final SortOrder
The sorting order for the returned list.final String
The sorting order for the returned list.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnDeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceAggregatedStatusFilterAsString()
.- Returns:
- Filter based on a device's status.
- See Also:
-
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 returnDeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceAggregatedStatusFilterAsString()
.- Returns:
- Filter based on a device's status.
- See Also:
-
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
Filter based on device's name. Prefixes supported.
- Returns:
- Filter based on device's name. Prefixes supported.
-
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
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 returnListDevicesSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The target column to be sorted on. Default column sort is CREATED_TIME.
- See Also:
-
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 returnListDevicesSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The target column to be sorted on. Default column sort is CREATED_TIME.
- See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
- See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
- See Also:
-
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 interfaceToCopyableBuilder<ListDevicesRequest.Builder,
ListDevicesRequest> - Specified by:
toBuilder
in classPanoramaRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-