Class ListIdentitiesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest
-
- All Implemented Interfaces:
ReadLimitInfo,Serializable,Cloneable
public class ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input to the ListIdentities action.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListIdentitiesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListIdentitiesRequestclone()Creates a shallow clone of this request.booleanequals(Object obj)BooleangetHideDisabled()An optional boolean parameter that allows you to hide disabled identities.StringgetIdentityPoolId()An identity pool ID in the format REGION:GUID.IntegergetMaxResults()The maximum number of identities to return.StringgetNextToken()A pagination token.inthashCode()BooleanisHideDisabled()An optional boolean parameter that allows you to hide disabled identities.voidsetHideDisabled(Boolean hideDisabled)An optional boolean parameter that allows you to hide disabled identities.voidsetIdentityPoolId(String identityPoolId)An identity pool ID in the format REGION:GUID.voidsetMaxResults(Integer maxResults)The maximum number of identities to return.voidsetNextToken(String nextToken)A pagination token.StringtoString()Returns a string representation of this object; useful for testing and debugging.ListIdentitiesRequestwithHideDisabled(Boolean hideDisabled)An optional boolean parameter that allows you to hide disabled identities.ListIdentitiesRequestwithIdentityPoolId(String identityPoolId)An identity pool ID in the format REGION:GUID.ListIdentitiesRequestwithMaxResults(Integer maxResults)The maximum number of identities to return.ListIdentitiesRequestwithNextToken(String nextToken)A pagination token.-
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
-
-
-
-
Method Detail
-
setIdentityPoolId
public void setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.- Parameters:
identityPoolId- An identity pool ID in the format REGION:GUID.
-
getIdentityPoolId
public String getIdentityPoolId()
An identity pool ID in the format REGION:GUID.- Returns:
- An identity pool ID in the format REGION:GUID.
-
withIdentityPoolId
public ListIdentitiesRequest withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.- Parameters:
identityPoolId- An identity pool ID in the format REGION:GUID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer maxResults)
The maximum number of identities to return.- Parameters:
maxResults- The maximum number of identities to return.
-
getMaxResults
public Integer getMaxResults()
The maximum number of identities to return.- Returns:
- The maximum number of identities to return.
-
withMaxResults
public ListIdentitiesRequest withMaxResults(Integer maxResults)
The maximum number of identities to return.- Parameters:
maxResults- The maximum number of identities to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
public void setNextToken(String nextToken)
A pagination token.- Parameters:
nextToken- A pagination token.
-
getNextToken
public String getNextToken()
A pagination token.- Returns:
- A pagination token.
-
withNextToken
public ListIdentitiesRequest withNextToken(String nextToken)
A pagination token.- Parameters:
nextToken- A pagination token.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHideDisabled
public void setHideDisabled(Boolean hideDisabled)
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
- Parameters:
hideDisabled- An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
-
getHideDisabled
public Boolean getHideDisabled()
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
- Returns:
- An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
-
withHideDisabled
public ListIdentitiesRequest withHideDisabled(Boolean hideDisabled)
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
- Parameters:
hideDisabled- An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isHideDisabled
public Boolean isHideDisabled()
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
- Returns:
- An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ListIdentitiesRequest clone()
Description copied from class:AmazonWebServiceRequestCreates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clonein classAmazonWebServiceRequest- See Also:
Object.clone()
-
-