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("software.amazon.awssdk:codegen")
public final class DescribeUsersRequest
extends WorkDocsRequest
implements ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeUsersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`authenticationToken()`	Amazon WorkDocs authentication token.
`static DescribeUsersRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fields()`	A comma-separated list of values.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeUsersRequest.Builder>`	`serializableBuilderClass()`
`UserSortType`	`sort()`	The sorting criteria.
`String`	`sortAsString()`	The sorting criteria.
`DescribeUsersRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userIds()`	The IDs of the users.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - authenticationToken
```
public final String authenticationToken()
```
    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.
  - organizationId
```
public final String organizationId()
```
    The ID of the organization.
    
    Returns:
    
    The ID of the organization.
  - userIds
```
public final String userIds()
```
    The IDs of the users.
    
    Returns:
    
    The IDs of the users.
  - query
```
public final 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.
    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.
  - include
```
public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final Integer limit()
```
    The maximum number of items to return.
    
    Returns:
    
    The maximum number of items to return.
  - fields
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>
    
    Specified by:
    
    toBuilder in class WorkDocsRequest
  - builder
```
public static DescribeUsersRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeUsersRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeUsersRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

authenticationToken

organizationId

userIds

query

include

includeAsString

order

orderAsString

sort

sortAsString

marker

limit

fields

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField