Interface ListUsersResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CognitoIdentityProviderResponse.Builder,CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>,SdkBuilder<ListUsersResponse.Builder,ListUsersResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- ListUsersResponse
public static interface ListUsersResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListUsersResponse.BuilderpaginationToken(String paginationToken)The identifier that Amazon Cognito returned with the previous request to this operation.ListUsersResponse.Builderusers(Collection<UserType> users)A list of the user pool users, and their attributes, that match your query.ListUsersResponse.Builderusers(Consumer<UserType.Builder>... users)A list of the user pool users, and their attributes, that match your query.ListUsersResponse.Builderusers(UserType... users)A list of the user pool users, and their attributes, that match your query.-
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
users
ListUsersResponse.Builder users(Collection<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
ListUsersdisplays both the IdP user and the native user that you linked. You can identify IdP users in theUsersobject of this API response by the IdP prefix that Amazon Cognito appends toUsername.- Parameters:
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
ListUsersdisplays both the IdP user and the native user that you linked. You can identify IdP users in theUsersobject of this API response by the IdP prefix that Amazon Cognito appends toUsername.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
users
ListUsersResponse.Builder users(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
ListUsersdisplays both the IdP user and the native user that you linked. You can identify IdP users in theUsersobject of this API response by the IdP prefix that Amazon Cognito appends toUsername.- Parameters:
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
ListUsersdisplays both the IdP user and the native user that you linked. You can identify IdP users in theUsersobject of this API response by the IdP prefix that Amazon Cognito appends toUsername.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
users
ListUsersResponse.Builder users(Consumer<UserType.Builder>... users)
A list of the user pool users, and their attributes, that match your query.
This is a convenience method that creates an instance of theAmazon 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
ListUsersdisplays both the IdP user and the native user that you linked. You can identify IdP users in theUsersobject of this API response by the IdP prefix that Amazon Cognito appends toUsername.UserType.Builderavoiding the need to create one manually viaUserType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#users(List.) - Parameters:
users- a consumer that will call methods onUserType.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#users(java.util.Collection)
-
paginationToken
ListUsersResponse.Builder paginationToken(String paginationToken)
The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.
- Parameters:
paginationToken- The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-