public class ListUsersRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to list users.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
attributesToGet
The attributes to get from the request to list users.
|
private java.lang.Integer |
limit
The limit of the request to list users.
|
private java.lang.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.
|
private java.lang.String |
userPoolId
The user pool ID for which you want to list users.
|
private java.lang.String |
userStatus
The user status.
|
NOOP
Constructor and Description |
---|
ListUsersRequest() |
Modifier and Type | Method and Description |
---|---|
ListUsersRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAttributesToGet()
The attributes to get from the request to list users.
|
java.lang.Integer |
getLimit()
The limit of the request to list users.
|
java.lang.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.
|
java.lang.String |
getUserPoolId()
The user pool ID for which you want to list users.
|
java.lang.String |
getUserStatus()
The user status.
|
int |
hashCode() |
void |
setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
The attributes to get from the request to list users.
|
void |
setLimit(java.lang.Integer limit)
The limit of the request to list users.
|
void |
setPaginationToken(java.lang.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(java.lang.String userPoolId)
The user pool ID for which you want to list users.
|
void |
setUserStatus(java.lang.String userStatus)
The user status.
|
void |
setUserStatus(UserStatusType userStatus)
The user status.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListUsersRequest |
withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
The attributes to get from the request to list users.
|
ListUsersRequest |
withAttributesToGet(java.lang.String... attributesToGet)
The attributes to get from the request to list users.
|
ListUsersRequest |
withLimit(java.lang.Integer limit)
The limit of the request to list users.
|
ListUsersRequest |
withPaginationToken(java.lang.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(java.lang.String userPoolId)
The user pool ID for which you want to list users.
|
ListUsersRequest |
withUserStatus(java.lang.String userStatus)
The user status.
|
ListUsersRequest |
withUserStatus(UserStatusType userStatus)
The user status.
|
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
private java.lang.String userPoolId
The user pool ID for which you want to list users.
private java.util.List<java.lang.String> attributesToGet
The attributes to get from the request to list users.
private java.lang.Integer limit
The limit of the request to list users.
private java.lang.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.
private java.lang.String userStatus
The user status. Can be one of the following:
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for which you want to list users.
userPoolId
- The user pool ID for which you want to list users.public java.lang.String getUserPoolId()
The user pool ID for which you want to list users.
public ListUsersRequest withUserPoolId(java.lang.String userPoolId)
The user pool ID for which you want to list users.
userPoolId
- The user pool ID for which you want to list users.public java.util.List<java.lang.String> getAttributesToGet()
The attributes to get from the request to list users.
public void setAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
The attributes to get from the request to list users.
attributesToGet
- The attributes to get from the request to list users.public ListUsersRequest withAttributesToGet(java.lang.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.
attributesToGet
- The attributes to get from the request to list users.public ListUsersRequest withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
The attributes to get from the request to list users.
attributesToGet
- The attributes to get from the request to list users.public void setLimit(java.lang.Integer limit)
The limit of the request to list users.
limit
- The limit of the request to list users.public java.lang.Integer getLimit()
The limit of the request to list users.
public ListUsersRequest withLimit(java.lang.Integer limit)
The limit of the request to list users.
limit
- The limit of the request to list users.public void setPaginationToken(java.lang.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.
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 java.lang.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.
public ListUsersRequest withPaginationToken(java.lang.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.
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 void setUserStatus(java.lang.String userStatus)
The user status. Can be one of the following:
userStatus
- The user status. Can be one of the following:
UserStatusType
public java.lang.String getUserStatus()
The user status. Can be one of the following:
UserStatusType
public ListUsersRequest withUserStatus(java.lang.String userStatus)
The user status. Can be one of the following:
userStatus
- The user status. Can be one of the following:
UserStatusType
public void setUserStatus(UserStatusType userStatus)
The user status. Can be one of the following:
userStatus
- The user status. Can be one of the following:
UserStatusType
public ListUsersRequest withUserStatus(UserStatusType userStatus)
The user status. Can be one of the following:
userStatus
- The user status. Can be one of the following:
UserStatusType
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ListUsersRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()