Interface SuggestionTextWithHighlights.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SuggestionTextWithHighlights.Builder,
,SuggestionTextWithHighlights> SdkBuilder<SuggestionTextWithHighlights.Builder,
,SuggestionTextWithHighlights> SdkPojo
- Enclosing class:
SuggestionTextWithHighlights
public static interface SuggestionTextWithHighlights.Builder
extends SdkPojo, CopyableBuilder<SuggestionTextWithHighlights.Builder,SuggestionTextWithHighlights>
-
Method Summary
Modifier and TypeMethodDescriptionhighlights
(Collection<SuggestionHighlight> highlights) The beginning and end of the query suggestion text that should be highlighted.highlights
(Consumer<SuggestionHighlight.Builder>... highlights) The beginning and end of the query suggestion text that should be highlighted.highlights
(SuggestionHighlight... highlights) The beginning and end of the query suggestion text that should be highlighted.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, sdkFields
-
Method Details
-
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
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
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 theSuggestionHighlight.Builder
avoiding the need to create one manually viaSuggestionHighlight.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohighlights(List<SuggestionHighlight>)
.- Parameters:
highlights
- a consumer that will call methods onSuggestionHighlight.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-