@Generated(value="software.amazon.awssdk:codegen") public final class ListUsersResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>
The response from the request to list users.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListUsersResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListUsersResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasUsers()
For responses, this returns true if the service returned a value for the Users property.
|
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 ListUsersResponse.Builder> |
serializableBuilderClass() |
ListUsersResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<UserType> |
users()
A list of the user pool users, and their attributes, that match your query.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasUsers()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<UserType> users()
A list of the user pool users, and their attributes, that match your query.
Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
the native user that you linked. You can identify IdP users in the Users object of this API response
by the IdP prefix that Amazon Cognito appends to Username.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasUsers() method.
Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each
unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP
user and the native user that you linked. You can identify IdP users in the Users object of
this API response by the IdP prefix that Amazon Cognito appends to Username.
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 ListUsersResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>toBuilder in class AwsResponsepublic static ListUsersResponse.Builder builder()
public static Class<? extends ListUsersResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.