Interface SearchRoomsRequest.Builder
- All Superinterfaces:
AlexaForBusinessRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchRoomsRequest.Builder,
,SearchRoomsRequest> SdkBuilder<SearchRoomsRequest.Builder,
,SearchRoomsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchRoomsRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<Filter> filters) The filters to use to list a specified set of rooms.filters
(Consumer<Filter.Builder>... filters) The filters to use to list a specified set of rooms.The filters to use to list a specified set of rooms.maxResults
(Integer maxResults) The maximum number of results to include in the response.An optional token returned from a prior request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sortCriteria
(Collection<Sort> sortCriteria) The sort order to use in listing the specified set of rooms.sortCriteria
(Consumer<Sort.Builder>... sortCriteria) The sort order to use in listing the specified set of rooms.sortCriteria
(Sort... sortCriteria) The sort order to use in listing the specified set of rooms.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
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 byMaxResults
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 specifiedMaxResults
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
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
- Parameters:
filters
- The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
- Parameters:
filters
- The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
This is a convenience method that creates an instance of theFilter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortCriteria
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
- Parameters:
sortCriteria
- The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortCriteria
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
- Parameters:
sortCriteria
- The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortCriteria
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
This is a convenience method that creates an instance of theSort.Builder
avoiding the need to create one manually viaSort.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortCriteria(List<Sort>)
.- Parameters:
sortCriteria
- a consumer that will call methods onSort.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchRoomsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchRoomsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-