Interface GetSearchResultsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetSearchResultsResponse.Builder,GetSearchResultsResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<GetSearchResultsResponse.Builder,GetSearchResultsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetSearchResultsResponse

@Mutable
@NotThreadSafe
public static interface GetSearchResultsResponse.Builder
extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<GetSearchResultsResponse.Builder,GetSearchResultsResponse>

Method Summary

Modifier and Type	Method	Description
GetSearchResultsResponse.Builder	nextToken(String nextToken)	The pagination token to use in a subsequent GetSearchResults call to retrieve the next page.
GetSearchResultsResponse.Builder	searchResults(Collection<SearchResult> searchResults)	A page of search results, ordered by descending relevance score.
GetSearchResultsResponse.Builder	searchResults(Consumer<SearchResult.Builder>... searchResults)	A page of search results, ordered by descending relevance score.
GetSearchResultsResponse.Builder	searchResults(SearchResult... searchResults)	A page of search results, ordered by descending relevance score.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

searchResults

GetSearchResultsResponse.Builder searchResults(Collection<SearchResult> searchResults)

A page of search results, ordered by descending relevance score.

Parameters:

searchResults - A page of search results, ordered by descending relevance score.

Returns:

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

searchResults

GetSearchResultsResponse.Builder searchResults(SearchResult... searchResults)

A page of search results, ordered by descending relevance score.

Parameters:

searchResults - A page of search results, ordered by descending relevance score.

Returns:

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

searchResults

GetSearchResultsResponse.Builder searchResults(Consumer<SearchResult.Builder>... searchResults)

A page of search results, ordered by descending relevance score.

This is a convenience method that creates an instance of the SearchResult.Builder avoiding the need to create one manually via SearchResult.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchResults(List<SearchResult>).

Parameters:

searchResults - a consumer that will call methods on SearchResult.Builder

Returns:

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

See Also:

• searchResults(java.util.Collection<SearchResult>)

nextToken

GetSearchResultsResponse.Builder nextToken(String nextToken)

The pagination token to use in a subsequent GetSearchResults call to retrieve the next page. Absent when there are no more results.

Parameters:

nextToken - The pagination token to use in a subsequent GetSearchResults call to retrieve the next page. Absent when there are no more results.

Returns:

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