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

Interface AutocompleteAddressHighlights.Builder

    • Method Detail

      • label

        AutocompleteAddressHighlights.Builder label​(Collection<Highlight> label)

        Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

        Parameters:
        label - Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • label

        AutocompleteAddressHighlights.Builder label​(Highlight... label)

        Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

        Parameters:
        label - Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • label

        AutocompleteAddressHighlights.Builder label​(Consumer<Highlight.Builder>... label)

        Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

        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)

      • country

        AutocompleteAddressHighlights.Builder country​(CountryHighlights country)

        The alpha-2 or alpha-3 character code for the country that the results will be present in.

        Parameters:
        country - The alpha-2 or alpha-3 character code for the country that the results will be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • region

        AutocompleteAddressHighlights.Builder region​(RegionHighlights region)

        The region or state results should be to be present in.

        Example: North Rhine-Westphalia.

        Parameters:
        region - The region or state results should be to be present in.

        Example: North Rhine-Westphalia.

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

      • subRegion

        AutocompleteAddressHighlights.Builder subRegion​(SubRegionHighlights subRegion)

        The sub-region or county for which results should be present in.

        Parameters:
        subRegion - The sub-region or county for which results should be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locality

        AutocompleteAddressHighlights.Builder locality​(Collection<Highlight> locality)

        The city or locality results should be present in.

        Example: Vancouver.

        Parameters:
        locality - The city or locality results should be present in.

        Example: Vancouver.

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

      • locality

        AutocompleteAddressHighlights.Builder locality​(Highlight... locality)

        The city or locality results should be present in.

        Example: Vancouver.

        Parameters:
        locality - The city or locality results should be present in.

        Example: Vancouver.

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

      • district

        AutocompleteAddressHighlights.Builder district​(Collection<Highlight> district)

        The district or division of a city the results should be present in.

        Parameters:
        district - The district or division of a city the results should be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • district

        AutocompleteAddressHighlights.Builder district​(Highlight... district)

        The district or division of a city the results should be present in.

        Parameters:
        district - The district or division of a city the results should be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subDistrict

        AutocompleteAddressHighlights.Builder subDistrict​(Collection<Highlight> subDistrict)

        Indicates the starting and ending index of the title in the text query that match the found title.

        Parameters:
        subDistrict - Indicates the starting and ending index of the title in the text query that match the found title.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subDistrict

        AutocompleteAddressHighlights.Builder subDistrict​(Highlight... subDistrict)

        Indicates the starting and ending index of the title in the text query that match the found title.

        Parameters:
        subDistrict - Indicates the starting and ending index of the title in the text query that match the found title.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • street

        AutocompleteAddressHighlights.Builder street​(Collection<Highlight> street)

        The name of the street results should be present in.

        Parameters:
        street - The name of the street results should be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • street

        AutocompleteAddressHighlights.Builder street​(Highlight... street)

        The name of the street results should be present in.

        Parameters:
        street - The name of the street results should be present in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • block

        AutocompleteAddressHighlights.Builder block​(Collection<Highlight> block)

        Name of the block. Example: Sunny Mansion 203 block: 2 Chome

        Parameters:
        block - Name of the block. Example: Sunny Mansion 203 block: 2 Chome
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • block

        AutocompleteAddressHighlights.Builder block​(Highlight... block)

        Name of the block. Example: Sunny Mansion 203 block: 2 Chome

        Parameters:
        block - Name of the block. Example: Sunny Mansion 203 block: 2 Chome
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subBlock

        AutocompleteAddressHighlights.Builder subBlock​(Collection<Highlight> subBlock)

        Name of sub-block. Example Sunny Mansion 203 sub-block: 4

        Parameters:
        subBlock - Name of sub-block. Example Sunny Mansion 203 sub-block: 4
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subBlock

        AutocompleteAddressHighlights.Builder subBlock​(Highlight... subBlock)

        Name of sub-block. Example Sunny Mansion 203 sub-block: 4

        Parameters:
        subBlock - Name of sub-block. Example Sunny Mansion 203 sub-block: 4
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • intersection

        AutocompleteAddressHighlights.Builder intersection​(Collection<? extends Collection<Highlight>> intersection)

        Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]

        Parameters:
        intersection - Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • intersection

        AutocompleteAddressHighlights.Builder intersection​(Collection<Highlight>... intersection)

        Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]

        Parameters:
        intersection - Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • postalCode

        AutocompleteAddressHighlights.Builder postalCode​(Collection<Highlight> postalCode)

        An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

        Parameters:
        postalCode - An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • postalCode

        AutocompleteAddressHighlights.Builder postalCode​(Highlight... postalCode)

        An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

        Parameters:
        postalCode - An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • postalCode

        AutocompleteAddressHighlights.Builder postalCode​(Consumer<Highlight.Builder>... postalCode)

        An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

        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 #postalCode(List).

        Parameters:
        postalCode - 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:
        #postalCode(java.util.Collection)

      • addressNumber

        AutocompleteAddressHighlights.Builder addressNumber​(Collection<Highlight> addressNumber)

        The house number or address results should have.

        Parameters:
        addressNumber - The house number or address results should have.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • addressNumber

        AutocompleteAddressHighlights.Builder addressNumber​(Highlight... addressNumber)

        The house number or address results should have.

        Parameters:
        addressNumber - The house number or address results should have.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • building

        AutocompleteAddressHighlights.Builder building​(Collection<Highlight> building)

        The name of the building at the address.

        Parameters:
        building - The name of the building at the address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • building

        AutocompleteAddressHighlights.Builder building​(Highlight... building)

        The name of the building at the address.

        Parameters:
        building - The name of the building at the address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.