com.amazonaws.services.workmail.model

Class ListUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workmail.model.ListUsersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, 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() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ListUsersFilters	getFilters() Limit the user search results based on the filter criteria.
Integer	getMaxResults() The maximum number of results to return in a single call.
String	getNextToken() The token to use to retrieve the next page of results.
String	getOrganizationId() The identifier for the organization under which the users exist.
int	hashCode()
void	setFilters(ListUsersFilters filters) Limit the user search results based on the filter criteria.
void	setMaxResults(Integer maxResults) The maximum number of results to return in a single call.
void	setNextToken(String nextToken) The token to use to retrieve the next page of results.
void	setOrganizationId(String organizationId) The identifier for the organization under which the users exist.
String	toString() Returns a string representation of this object.
ListUsersRequest	withFilters(ListUsersFilters filters) Limit the user search results based on the filter criteria.
ListUsersRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a single call.
ListUsersRequest	withNextToken(String nextToken) The token to use to retrieve the next page of results.
ListUsersRequest	withOrganizationId(String organizationId) The identifier for the organization under which the users exist.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

Method Detail

setOrganizationId

public void setOrganizationId(String organizationId)

The identifier for the organization under which the users exist.

Parameters:

organizationId - The identifier for the organization under which the users exist.

getOrganizationId

public String getOrganizationId()

The identifier for the organization under which the users exist.

Returns:

The identifier for the organization under which the users exist.

withOrganizationId

public ListUsersRequest withOrganizationId(String organizationId)

The identifier for the organization under which the users exist.

Parameters:

organizationId - The identifier for the organization under which the users exist.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Parameters:

nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

getNextToken

public String getNextToken()

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Returns:

The token to use to retrieve the next page of results. The first call does not contain any tokens.

withNextToken

public ListUsersRequest withNextToken(String nextToken)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Parameters:

nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

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 results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in a single call.

Returns:

The maximum number of results to return in a single call.

withMaxResults

public ListUsersRequest withMaxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

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

setFilters

public void setFilters(ListUsersFilters filters)

Limit the user search results based on the filter criteria. You can only use one filter per request.

Parameters:

filters - Limit the user search results based on the filter criteria. You can only use one filter per request.

getFilters

public ListUsersFilters getFilters()

Limit the user search results based on the filter criteria. You can only use one filter per request.

Returns:

Limit the user search results based on the filter criteria. You can only use one filter per request.

withFilters

public ListUsersRequest withFilters(ListUsersFilters filters)

Limit the user search results based on the filter criteria. You can only use one filter per request.

Parameters:

filters - Limit the user search results based on the filter criteria. You can only use one filter per 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()