software.amazon.awssdk.services.workdocs.model

Interface DescribeUsersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>, SdkBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>, SdkPojo, SdkRequest.Builder, WorkDocsRequest.Builder

Enclosing class:

DescribeUsersRequest

public static interface DescribeUsersRequest.Builder
extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Method Summary

Modifier and Type	Method and Description
DescribeUsersRequest.Builder	authenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
DescribeUsersRequest.Builder	fields(String fields) A comma-separated list of values.
DescribeUsersRequest.Builder	include(String include) The state of the users.
DescribeUsersRequest.Builder	include(UserFilterType include) The state of the users.
DescribeUsersRequest.Builder	limit(Integer limit) The maximum number of items to return.
DescribeUsersRequest.Builder	marker(String marker) The marker for the next set of results.
DescribeUsersRequest.Builder	order(OrderType order) The order for the results.
DescribeUsersRequest.Builder	order(String order) The order for the results.
DescribeUsersRequest.Builder	organizationId(String organizationId) The ID of the organization.
DescribeUsersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeUsersRequest.Builder	query(String query) A query to filter users by user name.
DescribeUsersRequest.Builder	sort(String sort) The sorting criteria.
DescribeUsersRequest.Builder	sort(UserSortType sort) The sorting criteria.
DescribeUsersRequest.Builder	userIds(String userIds) The IDs of the users.

Methods inherited from interface software.amazon.awssdk.services.workdocs.model.WorkDocsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

authenticationToken

DescribeUsersRequest.Builder authenticationToken(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.

organizationId

DescribeUsersRequest.Builder organizationId(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.

userIds

DescribeUsersRequest.Builder userIds(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.

query

DescribeUsersRequest.Builder query(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.

include

DescribeUsersRequest.Builder include(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, UserFilterType

include

DescribeUsersRequest.Builder include(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, UserFilterType

order

DescribeUsersRequest.Builder order(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, OrderType

order

DescribeUsersRequest.Builder order(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, OrderType

sort

DescribeUsersRequest.Builder sort(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, UserSortType

sort

DescribeUsersRequest.Builder sort(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, UserSortType

marker

DescribeUsersRequest.Builder marker(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.

limit

DescribeUsersRequest.Builder limit(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.

fields

DescribeUsersRequest.Builder fields(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.

overrideConfiguration

DescribeUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeUsersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder