ListUsersRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.ListUsersRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable
```
Lists the users in the Amazon Cognito user pool.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListUsersRequest()

Constructors
Constructor and Description
`ListUsersRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<String>`	`getAttributesToGet()` The attributes to get from the request to list users.
`String`	`getFilter()` The filter for the list users request.
`Integer`	`getLimit()` The limit of the request to list users.
`String`	`getPaginationToken()` 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.
`String`	`getUserPoolId()` The user pool ID for which you want to list users.
`int`	`hashCode()`
`void`	`setAttributesToGet(Collection<String> attributesToGet)` The attributes to get from the request to list users.
`void`	`setFilter(String filter)` The filter for the list users request.
`void`	`setLimit(Integer limit)` The limit of the request to list users.
`void`	`setPaginationToken(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.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for which you want to list users.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListUsersRequest`	`withAttributesToGet(Collection<String> attributesToGet)` The attributes to get from the request to list users.
`ListUsersRequest`	`withAttributesToGet(String... attributesToGet)` The attributes to get from the request to list users.
`ListUsersRequest`	`withFilter(String filter)` The filter for the list users request.
`ListUsersRequest`	`withLimit(Integer limit)` The limit of the request to list users.
`ListUsersRequest`	`withPaginationToken(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.
`ListUsersRequest`	`withUserPoolId(String userPoolId)` The user pool ID for which you want to list users.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListUsersRequest
```
public ListUsersRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for which you want to list users.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for which you want to list users.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for which you want to list users.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for which you want to list users.
  - withUserPoolId
```
public ListUsersRequest withUserPoolId(String userPoolId)
```
    The user pool ID for which you want to list users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for which you want to list users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributesToGet
```
public List<String> getAttributesToGet()
```
    The attributes to get from the request to list users.
    
    Returns:
    
    The attributes to get from the request to list users.
  - setAttributesToGet
```
public void setAttributesToGet(Collection<String> attributesToGet)
```
    The attributes to get from the request to list users.
    
    Parameters:
    
    attributesToGet -
    The attributes to get from the request to list users.
  - withAttributesToGet
```
public ListUsersRequest withAttributesToGet(String... attributesToGet)
```
    The attributes to get from the request to list users.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributesToGet -
    The attributes to get from the request to list users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAttributesToGet
```
public ListUsersRequest withAttributesToGet(Collection<String> attributesToGet)
```
    The attributes to get from the request to list users.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributesToGet -
    The attributes to get from the request to list users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public Integer getLimit()
```
    The limit of the request to list users.
    
    Constraints:
    Range: 0 - 60
    
    Returns:
    
    The limit of the request to list users.
  - setLimit
```
public void setLimit(Integer limit)
```
    The limit of the request to list users.
    
    Constraints:
    Range: 0 - 60
    
    Parameters:
    
    limit -
    The limit of the request to list users.
  - withLimit
```
public ListUsersRequest withLimit(Integer limit)
```
    The limit of the request to list users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 - 60
    
    Parameters:
    
    limit -
    The limit of the request to list users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPaginationToken
```
public String getPaginationToken()
```
    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.
    
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    Returns:
    
    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.
  - setPaginationToken
```
public void setPaginationToken(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.
    
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    Parameters:
    
    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.
  - withPaginationToken
```
public ListUsersRequest withPaginationToken(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFilter
```
public String getFilter()
```
    The filter for the list users request.
    
    Constraints:
    Length: - 256
    
    Returns:
    
    The filter for the list users request.
  - setFilter
```
public void setFilter(String filter)
```
    The filter for the list users request.
    
    Constraints:
    Length: - 256
    
    Parameters:
    
    filter -
    The filter for the list users request.
  - withFilter
```
public ListUsersRequest withFilter(String filter)
```
    The filter for the list users request.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 256
    
    Parameters:
    
    filter -
    The filter for the list users request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ListUsersRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListUsersRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getAttributesToGet

setAttributesToGet

withAttributesToGet

withAttributesToGet

getLimit

setLimit

withLimit

getPaginationToken

setPaginationToken

withPaginationToken

getFilter

setFilter

withFilter

toString

hashCode

equals