software.amazon.awssdk.services.alexaforbusiness.model

Interface SearchUsersRequest.Builder

All Superinterfaces:

AlexaForBusinessRequest.Builder, AwsRequest.Builder, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, SdkBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, SdkRequest.Builder

Enclosing class:

SearchUsersRequest

public static interface SearchUsersRequest.Builder
extends AlexaForBusinessRequest.Builder, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Method Summary

Modifier and Type	Method and Description
SearchUsersRequest.Builder	filters(Collection<Filter> filters) The filters to use for listing a specific set of users.
SearchUsersRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters to use for listing a specific set of users.
SearchUsersRequest.Builder	filters(Filter... filters) The filters to use for listing a specific set of users.
SearchUsersRequest.Builder	maxResults(Integer maxResults) The maximum number of results to include in the response.
SearchUsersRequest.Builder	nextToken(String nextToken) An optional token returned from a prior request.
SearchUsersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
SearchUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
SearchUsersRequest.Builder	sortCriteria(Collection<Sort> sortCriteria) The sort order to use in listing the filtered set of users.
SearchUsersRequest.Builder	sortCriteria(Consumer<Sort.Builder>... sortCriteria) The sort order to use in listing the filtered set of users.
SearchUsersRequest.Builder	sortCriteria(Sort... sortCriteria) The sort order to use in listing the filtered set of users.

Methods inherited from interface software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest.Builder

build

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

overrideConfiguration

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

nextToken

SearchUsersRequest.Builder nextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

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 include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

Returns:

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

filters

SearchUsersRequest.Builder filters(Collection<Filter> filters)

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Parameters:

filters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:

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

filters

SearchUsersRequest.Builder filters(Filter... filters)

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Parameters:

filters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:

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

filters

SearchUsersRequest.Builder filters(Consumer<Filter.Builder>... filters)

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

sortCriteria

SearchUsersRequest.Builder sortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Parameters:

sortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:

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

sortCriteria

SearchUsersRequest.Builder sortCriteria(Sort... sortCriteria)

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Parameters:

sortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Returns:

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

sortCriteria

SearchUsersRequest.Builder sortCriteria(Consumer<Sort.Builder>... sortCriteria)

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sortCriteria(List).

Parameters:

sortCriteria - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sortCriteria(List)

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.