Package software.amazon.awssdk.services.geoplaces.model

Interface SuggestAddressHighlights.Builder

    • Method Detail

      • 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).

        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)