Package software.amazon.awssdk.services.location.model

Interface SearchForSuggestionsResult.Builder

    • Method Detail

      • categories

        SearchForSuggestionsResult.Builder categories​(Collection<String> categories)

        The Amazon Location categories that describe the Place.

        For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

        Parameters:
        categories - The Amazon Location categories that describe the Place.

        For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

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

      • categories

        SearchForSuggestionsResult.Builder categories​(String... categories)

        The Amazon Location categories that describe the Place.

        For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

        Parameters:
        categories - The Amazon Location categories that describe the Place.

        For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

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

      • placeId

        SearchForSuggestionsResult.Builder placeId​(String placeId)

        The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.

        The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.

        For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

        Parameters:
        placeId - The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.

        The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.

        For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

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

      • supplementalCategories

        SearchForSuggestionsResult.Builder supplementalCategories​(Collection<String> supplementalCategories)

        Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

        Parameters:
        supplementalCategories - Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supplementalCategories

        SearchForSuggestionsResult.Builder supplementalCategories​(String... supplementalCategories)

        Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

        Parameters:
        supplementalCategories - Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • text

        SearchForSuggestionsResult.Builder text​(String text)

        The text of the place suggestion, typically formatted as an address string.

        Parameters:
        text - The text of the place suggestion, typically formatted as an address string.
        Returns:
        Returns a reference to this object so that method calls can be chained together.