Interface SuggestAddressHighlights.Builder

All Superinterfaces:

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

Enclosing class:

SuggestAddressHighlights

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

Method Summary

Modifier and Type	Method	Description
SuggestAddressHighlights.Builder	label(Collection<Highlight> label)	Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery.
SuggestAddressHighlights.Builder	label(Consumer<Highlight.Builder>... label)	Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery.
SuggestAddressHighlights.Builder	label(Highlight... label)	Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery.

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

label

SuggestAddressHighlights.Builder label(Collection<Highlight> label)

Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

Parameters:

label - Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

Returns:

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

label

SuggestAddressHighlights.Builder label(Highlight... label)

Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

Parameters:

label - Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

Returns:

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

label

SuggestAddressHighlights.Builder label(Consumer<Highlight.Builder>... label)

Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

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

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

Parameters:

label - a consumer that will call methods on Highlight.Builder

Returns:

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

See Also:

• label(java.util.Collection<Highlight>)