Interface ListUsersResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>, SdkBuilder<ListUsersResponse.Builder,ListUsersResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
ListUsersResponse
@Mutable @NotThreadSafe public static interface ListUsersResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

  • Method Details

    • users

      ListUsersResponse.Builder users(Collection<UserType> users)

      An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.

      Parameters:
      users - An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • users

      ListUsersResponse.Builder users(UserType... users)

      An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.

      Parameters:
      users - An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • users

      ListUsersResponse.Builder users(Consumer<UserType.Builder>... users)

      An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.

      This is a convenience method that creates an instance of the UserType.Builder avoiding the need to create one manually via UserType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to users(List<UserType>).

      Parameters:
      users - a consumer that will call methods on UserType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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