Interface SuggestModel.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SuggestModel.Builder,SuggestModel>, SdkBuilder<SuggestModel.Builder,SuggestModel>, SdkPojo

Enclosing class:

SuggestModel

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

Method Summary

Modifier and Type	Method	Description
SuggestModel.Builder	found(Long found)	The number of documents that were found to match the query string.
SuggestModel.Builder	query(String query)	The query string specified in the suggest request.
SuggestModel.Builder	suggestions(Collection<SuggestionMatch> suggestions)	The documents that match the query string.
SuggestModel.Builder	suggestions(Consumer<SuggestionMatch.Builder>... suggestions)	The documents that match the query string.
SuggestModel.Builder	suggestions(SuggestionMatch... suggestions)	The documents that match the query string.

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, sdkFieldNameToField, sdkFields

Method Details

query

SuggestModel.Builder query(String query)

The query string specified in the suggest request.

Parameters:

query - The query string specified in the suggest request.

Returns:

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

found

SuggestModel.Builder found(Long found)

The number of documents that were found to match the query string.

Parameters:

found - The number of documents that were found to match the query string.

Returns:

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

suggestions

SuggestModel.Builder suggestions(Collection<SuggestionMatch> suggestions)

The documents that match the query string.

Parameters:

suggestions - The documents that match the query string.

Returns:

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

suggestions

SuggestModel.Builder suggestions(SuggestionMatch... suggestions)

The documents that match the query string.

Parameters:

suggestions - The documents that match the query string.

Returns:

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

suggestions

SuggestModel.Builder suggestions(Consumer<SuggestionMatch.Builder>... suggestions)

The documents that match the query string.

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

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

Parameters:

suggestions - a consumer that will call methods on SuggestionMatch.Builder

Returns:

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

See Also:

• suggestions(java.util.Collection<SuggestionMatch>)