Package software.amazon.awssdk.services.workdocs.model

Class DescribeUsersRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.workdocs.model.DescribeUsersRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeUsersRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeUsersRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	authenticationToken()	Amazon WorkDocs authentication token.
static DescribeUsersRequest.Builder	builder()
boolean	equals(Object obj)
String	fields()	A comma-separated list of values.
int	hashCode()
String	include()	The state of the users.
Integer	limit()	The maximum number of items to return.
String	marker()	The marker for the next set of results.
String	order()	The order for the results.
String	organizationId()	The ID of the organization.
String	query()	A query to filter users by user name.
static Class<? extends DescribeUsersRequest.Builder>	serializableBuilderClass()
String	sort()	The sorting criteria.
DescribeUsersRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userIds()	The IDs of the users.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

authenticationToken

public String authenticationToken()

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

organizationId

public String organizationId()

The ID of the organization.

Returns:

The ID of the organization.

userIds

public String userIds()

The IDs of the users.

Returns:

The IDs of the users.

query

public String query()

A query to filter users by user name.

Returns:

A query to filter users by user name.

include

public String include()

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

order

public String order()

The order for the results.

Returns:

The order for the results.

See Also:

OrderType

sort

public String sort()

The sorting criteria.

Returns:

The sorting criteria.

See Also:

UserSortType

marker

public String marker()

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

limit

public Integer limit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

fields

public String fields()

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.

toBuilder

public DescribeUsersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Returns:

a builder for type T

builder

public static DescribeUsersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeUsersRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object