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

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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