@Generated(value="software.amazon.awssdk:codegen") public final class ListUsersRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>
Represents the request to list users.
Modifier and Type | Class and Description |
---|---|
static interface |
ListUsersRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
attributesToGet()
An array of strings, where each string is the name of a user attribute to be returned for each user in the search
results.
|
static ListUsersRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
filter()
A filter string of the form "AttributeName Filter-Type "AttributeValue"".
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAttributesToGet()
Returns true if the AttributesToGet 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() |
Integer |
limit()
Maximum number of users to be returned.
|
String |
paginationToken()
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListUsersRequest.Builder> |
serializableBuilderClass() |
ListUsersRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
userPoolId()
The user pool ID for the user pool on which the search should be performed.
|
overrideConfiguration
copy
public final String userPoolId()
The user pool ID for the user pool on which the search should be performed.
public final boolean hasAttributesToGet()
public final List<String> attributesToGet()
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributesToGet()
to see if a value was sent in this field.
public final Integer limit()
Maximum number of users to be returned.
public final String paginationToken()
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.
public final String filter()
A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
within the filter string must be escaped using the backslash (\) character. For example, "
family_name
= \"Reddy\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name
= \"Jon\"". For a prefix
("starts with") match, use ^=, for example, "given_name
^= \"Jon\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
family_name
= \"Reddy\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name
= \"Jon\"". For a
prefix ("starts with") match, use ^=, for example, "given_name
^= \"Jon\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
public ListUsersRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static ListUsersRequest.Builder builder()
public static Class<? extends ListUsersRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.