com.amazonaws.services.workdocs.model

Class DescribeUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.DescribeUsersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeUsersRequest
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
DescribeUsersRequest()

Method Summary

Modifier and Type	Method and Description
DescribeUsersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthenticationToken() Amazon WorkDocs authentication token.
String	getFields() A comma-separated list of values.
String	getInclude() The state of the users.
Integer	getLimit() The maximum number of items to return.
String	getMarker() The marker for the next set of results.
String	getOrder() The order for the results.
String	getOrganizationId() The ID of the organization.
String	getQuery() A query to filter users by user name.
String	getSort() The sorting criteria.
String	getUserIds() The IDs of the users.
int	hashCode()
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setFields(String fields) A comma-separated list of values.
void	setInclude(String include) The state of the users.
void	setInclude(UserFilterType include) The state of the users.
void	setLimit(Integer limit) The maximum number of items to return.
void	setMarker(String marker) The marker for the next set of results.
void	setOrder(OrderType order) The order for the results.
void	setOrder(String order) The order for the results.
void	setOrganizationId(String organizationId) The ID of the organization.
void	setQuery(String query) A query to filter users by user name.
void	setSort(String sort) The sorting criteria.
void	setSort(UserSortType sort) The sorting criteria.
void	setUserIds(String userIds) The IDs of the users.
String	toString() Returns a string representation of this object.
DescribeUsersRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
DescribeUsersRequest	withFields(String fields) A comma-separated list of values.
DescribeUsersRequest	withInclude(String include) The state of the users.
DescribeUsersRequest	withInclude(UserFilterType include) The state of the users.
DescribeUsersRequest	withLimit(Integer limit) The maximum number of items to return.
DescribeUsersRequest	withMarker(String marker) The marker for the next set of results.
DescribeUsersRequest	withOrder(OrderType order) The order for the results.
DescribeUsersRequest	withOrder(String order) The order for the results.
DescribeUsersRequest	withOrganizationId(String organizationId) The ID of the organization.
DescribeUsersRequest	withQuery(String query) A query to filter users by user name.
DescribeUsersRequest	withSort(String sort) The sorting criteria.
DescribeUsersRequest	withSort(UserSortType sort) The sorting criteria.
DescribeUsersRequest	withUserIds(String userIds) The IDs of the users.

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

DescribeUsersRequest

public DescribeUsersRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

getAuthenticationToken

public String getAuthenticationToken()

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

withAuthenticationToken

public DescribeUsersRequest withAuthenticationToken(String authenticationToken)

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Parameters:

authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

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

setOrganizationId

public void setOrganizationId(String organizationId)

The ID of the organization.

Parameters:

organizationId - The ID of the organization.

getOrganizationId

public String getOrganizationId()

The ID of the organization.

Returns:

The ID of the organization.

withOrganizationId

public DescribeUsersRequest withOrganizationId(String organizationId)

The ID of the organization.

Parameters:

organizationId - The ID of the organization.

Returns:

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

setUserIds

public void setUserIds(String userIds)

The IDs of the users.

Parameters:

userIds - The IDs of the users.

getUserIds

public String getUserIds()

The IDs of the users.

Returns:

The IDs of the users.

withUserIds

public DescribeUsersRequest withUserIds(String userIds)

The IDs of the users.

Parameters:

userIds - The IDs of the users.

Returns:

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

setQuery

public void setQuery(String query)

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

Parameters:

query - A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

getQuery

public String getQuery()

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

Returns:

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

withQuery

public DescribeUsersRequest withQuery(String query)

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

Parameters:

query - A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

Returns:

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

setInclude

public void setInclude(String include)

The state of the users. Specify "ALL" to include inactive users.

Parameters:

include - The state of the users. Specify "ALL" to include inactive users.

See Also:

UserFilterType

getInclude

public String getInclude()

The state of the users. Specify "ALL" to include inactive users.

Returns:

The state of the users. Specify "ALL" to include inactive users.

See Also:

UserFilterType

withInclude

public DescribeUsersRequest withInclude(String include)

The state of the users. Specify "ALL" to include inactive users.

Parameters:

include - The state of the users. Specify "ALL" to include inactive users.

Returns:

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

See Also:

UserFilterType

setInclude

public void setInclude(UserFilterType include)

The state of the users. Specify "ALL" to include inactive users.

Parameters:

include - The state of the users. Specify "ALL" to include inactive users.

See Also:

UserFilterType

withInclude

public DescribeUsersRequest withInclude(UserFilterType include)

The state of the users. Specify "ALL" to include inactive users.

Parameters:

include - The state of the users. Specify "ALL" to include inactive users.

Returns:

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

See Also:

UserFilterType

setOrder

public void setOrder(String order)

The order for the results.

Parameters:

order - The order for the results.

See Also:

OrderType

getOrder

public String getOrder()

The order for the results.

Returns:

The order for the results.

See Also:

OrderType

withOrder

public DescribeUsersRequest withOrder(String order)

The order for the results.

Parameters:

order - The order for the results.

Returns:

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

See Also:

OrderType

setOrder

public void setOrder(OrderType order)

The order for the results.

Parameters:

order - The order for the results.

See Also:

OrderType

withOrder

public DescribeUsersRequest withOrder(OrderType order)

The order for the results.

Parameters:

order - The order for the results.

Returns:

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

See Also:

OrderType

setSort

public void setSort(String sort)

The sorting criteria.

Parameters:

sort - The sorting criteria.

See Also:

UserSortType

getSort

public String getSort()

The sorting criteria.

Returns:

The sorting criteria.

See Also:

UserSortType

withSort

public DescribeUsersRequest withSort(String sort)

The sorting criteria.

Parameters:

sort - The sorting criteria.

Returns:

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

See Also:

UserSortType

setSort

public void setSort(UserSortType sort)

The sorting criteria.

Parameters:

sort - The sorting criteria.

See Also:

UserSortType

withSort

public DescribeUsersRequest withSort(UserSortType sort)

The sorting criteria.

Parameters:

sort - The sorting criteria.

Returns:

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

See Also:

UserSortType

setMarker

public void setMarker(String marker)

The marker for the next set of results. (You received this marker from a previous call.)

Parameters:

marker - The marker for the next set of results. (You received this marker from a previous call.)

getMarker

public String getMarker()

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

The marker for the next set of results. (You received this marker from a previous call.)

withMarker

public DescribeUsersRequest withMarker(String marker)

The marker for the next set of results. (You received this marker from a previous call.)

Parameters:

marker - The marker for the next set of results. (You received this marker from a previous call.)

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of items to return.

Parameters:

limit - The maximum number of items to return.

getLimit

public Integer getLimit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

withLimit

public DescribeUsersRequest withLimit(Integer limit)

The maximum number of items to return.

Parameters:

limit - The maximum number of items to return.

Returns:

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

setFields

public void setFields(String fields)

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Parameters:

fields - A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

getFields

public String getFields()

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Returns:

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

withFields

public DescribeUsersRequest withFields(String fields)

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Parameters:

fields - A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

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