software.amazon.awssdk.services.alexaforbusiness.model

Interface SearchProfilesRequest.Builder

All Superinterfaces:

AlexaForBusinessRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>, SdkBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchProfilesRequest

public static interface SearchProfilesRequest.Builder
extends AlexaForBusinessRequest.Builder, SdkPojo, CopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>

Method Summary

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

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.core.SdkPojo

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

nextToken

SearchProfilesRequest.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.

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.

Returns:

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

maxResults

SearchProfilesRequest.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.

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.

Returns:

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

filters

SearchProfilesRequest.Builder filters(Collection<Filter> filters)

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Parameters:

filters - The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Returns:

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

filters

SearchProfilesRequest.Builder filters(Filter... filters)

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Parameters:

filters - The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Returns:

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

filters

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

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

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

SearchProfilesRequest.Builder sortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Parameters:

sortCriteria - The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Returns:

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

sortCriteria

SearchProfilesRequest.Builder sortCriteria(Sort... sortCriteria)

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Parameters:

sortCriteria - The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Returns:

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

sortCriteria

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

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

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

SearchProfilesRequest.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

SearchProfilesRequest.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.