Interface SuggestionTextWithHighlights.Builder

All Superinterfaces:

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

Enclosing class:

SuggestionTextWithHighlights

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

Method Summary

Modifier and Type	Method	Description
SuggestionTextWithHighlights.Builder	highlights(Collection<SuggestionHighlight> highlights)	The beginning and end of the query suggestion text that should be highlighted.
SuggestionTextWithHighlights.Builder	highlights(Consumer<SuggestionHighlight.Builder>... highlights)	The beginning and end of the query suggestion text that should be highlighted.
SuggestionTextWithHighlights.Builder	highlights(SuggestionHighlight... highlights)	The beginning and end of the query suggestion text that should be highlighted.
SuggestionTextWithHighlights.Builder	text(String text)	The query suggestion text to display to the user.

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

text

SuggestionTextWithHighlights.Builder text(String text)

The query suggestion text to display to the user.

Parameters:

text - The query suggestion text to display to the user.

Returns:

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

highlights

SuggestionTextWithHighlights.Builder highlights(Collection<SuggestionHighlight> highlights)

The beginning and end of the query suggestion text that should be highlighted.

Parameters:

highlights - The beginning and end of the query suggestion text that should be highlighted.

Returns:

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

highlights

SuggestionTextWithHighlights.Builder highlights(SuggestionHighlight... highlights)

The beginning and end of the query suggestion text that should be highlighted.

Parameters:

highlights - The beginning and end of the query suggestion text that should be highlighted.

Returns:

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

highlights

SuggestionTextWithHighlights.Builder highlights(Consumer<SuggestionHighlight.Builder>... highlights)

The beginning and end of the query suggestion text that should be highlighted.

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

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

Parameters:

highlights - a consumer that will call methods on SuggestionHighlight.Builder

Returns:

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

See Also:

• highlights(java.util.Collection<SuggestionHighlight>)