software.amazon.awssdk.services.workdocs.model

Class DescribeUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workdocs.model.WorkDocsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeUsersRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authenticationToken() Amazon WorkDocs authentication token.
static DescribeUsersRequest.Builder	builder()
boolean	equals(Object obj)
String	fields() A comma-separated list of values.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
UserFilterType	include() The state of the users.
String	includeAsString() The state of the users.
Integer	limit() The maximum number of items to return.
String	marker() The marker for the next set of results.
OrderType	order() The order for the results.
String	orderAsString() The order for the results.
String	organizationId() The ID of the organization.
String	query() A query to filter users by user name.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUsersRequest.Builder>	serializableBuilderClass()
UserSortType	sort() The sorting criteria.
String	sortAsString() 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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authenticationToken

public String authenticationToken()

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

Returns:

Amazon WorkDocs authentication token. Do not set this field 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 UserFilterType include()

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

If the service returns an enum value that is not available in the current SDK version, include will return UserFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeAsString().

Returns:

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

See Also:

UserFilterType

includeAsString

public String includeAsString()

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

If the service returns an enum value that is not available in the current SDK version, include will return UserFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeAsString().

Returns:

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

See Also:

UserFilterType

order

public OrderType order()

The order for the results.

If the service returns an enum value that is not available in the current SDK version, order will return OrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order for the results.

See Also:

OrderType

orderAsString

public String orderAsString()

The order for the results.

If the service returns an enum value that is not available in the current SDK version, order will return OrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order for the results.

See Also:

OrderType

sort

public UserSortType sort()

The sorting criteria.

If the service returns an enum value that is not available in the current SDK version, sort will return UserSortType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

Returns:

The sorting criteria.

See Also:

UserSortType

sortAsString

public String sortAsString()

The sorting criteria.

If the service returns an enum value that is not available in the current SDK version, sort will return UserSortType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

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>

Specified by:

toBuilder in class WorkDocsRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.