com.amazonaws.services.cognitoidp.model

Class ListUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.ListUsersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to list users.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListUsersRequest()

Method Summary

Modifier and Type	Method and Description
ListUsersRequest	clone()
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

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for which you want to list users.

Parameters:

userPoolId - The user pool ID for which you want to list users.

getUserPoolId

public String getUserPoolId()

The user pool ID for which you want to list users.

Returns:

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.

Parameters:

userPoolId - The user pool ID for which you want to list users.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setAttributesToGet(java.util.Collection) or withAttributesToGet(java.util.Collection) if you want to override the existing values.

Parameters:

attributesToGet - The attributes to get from the request to list users.

Returns:

Returns a reference to this 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.

Parameters:

attributesToGet - The attributes to get from the request to list users.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLimit

public void setLimit(Integer limit)

The limit of the request to list users.

Parameters:

limit - The limit of the request to list users.

getLimit

public Integer getLimit()

The limit of the request to list users.

Returns:

The limit of the request to list users.

withLimit

public ListUsersRequest withLimit(Integer limit)

The limit of the request to list users.

Parameters:

limit - The limit of the request to list users.

Returns:

Returns a reference to this object so that method calls can be chained together.

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.

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.

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.

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.

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.

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:

Returns a reference to this object so that method calls can be chained together.

setFilter

public void setFilter(String filter)

The filter for the list users request.

Parameters:

filter - The filter for the list users request.

getFilter

public String getFilter()

The filter for the list users request.

Returns:

The filter for the list users request.

withFilter

public ListUsersRequest withFilter(String filter)

The filter for the list users request.

Parameters:

filter - The filter for the list users request.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListUsersRequest clone()

Overrides:

clone in class AmazonWebServiceRequest