Interface SearchUsersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, DirectoryServiceDataRequest.Builder, SdkBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchUsersRequest
public static interface SearchUsersRequest.Builder extends DirectoryServiceDataRequest.Builder, SdkPojo, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

  • Method Details

    • directoryId

      SearchUsersRequest.Builder directoryId(String directoryId)

      The identifier (ID) of the directory that's associated with the user.

      Parameters:
      directoryId - The identifier (ID) of the directory that's associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      SearchUsersRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to be returned per request.

      Parameters:
      maxResults - The maximum number of results to be returned per request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      SearchUsersRequest.Builder nextToken(String nextToken)

      An encoded paging token for paginated calls that can be passed back to retrieve the next page.

      Parameters:
      nextToken - An encoded paging token for paginated calls that can be passed back to retrieve the next page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • realm

      SearchUsersRequest.Builder realm(String realm)

      The domain name that's associated with the user.

      This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

      This value is case insensitive.

      Parameters:
      realm - The domain name that's associated with the user.

      This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

      This value is case insensitive.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchAttributes

      SearchUsersRequest.Builder searchAttributes(Collection<String> searchAttributes)

      One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.

      Parameters:
      searchAttributes - One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchAttributes

      SearchUsersRequest.Builder searchAttributes(String... searchAttributes)

      One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.

      Parameters:
      searchAttributes - One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchString

      SearchUsersRequest.Builder searchString(String searchString)

      The attribute value that you want to search for.

      Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.

      Parameters:
      searchString - The attribute value that you want to search for.

      Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SearchUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchUsersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.