software.amazon.awssdk.services.alexaforbusiness.model

Class SearchUsersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchUsersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchUsersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() The filters to use for listing a specific set of users.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSortCriteria() Returns true if the SortCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 SearchUsersRequest.Builder>	serializableBuilderClass()
List<Sort>	sortCriteria() The sort order to use in listing the filtered set of users.
SearchUsersRequest.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 final 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. Required.

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

maxResults

public final 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. Required.

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

hasFilters

public final boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public final List<Filter> filters()

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

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

You can use hasFilters() to see if a value was sent in this field.

Returns:

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

hasSortCriteria

public final boolean hasSortCriteria()

Returns true if the SortCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sortCriteria

public final List<Sort> sortCriteria()

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

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

You can use hasSortCriteria() to see if a value was sent in this field.

Returns:

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

toBuilder

public SearchUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static SearchUsersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchUsersRequest.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