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

Interface SearchPlaceIndexForTextRequest.Builder

    • Method Detail

      • biasPosition

        SearchPlaceIndexForTextRequest.Builder biasPosition​(Collection<Double> biasPosition)

        An optional parameter that indicates a preference for places that are closer to a specified position.

        If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

        For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

        BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

        Parameters:
        biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.

        If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

        For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

        BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

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

      • biasPosition

        SearchPlaceIndexForTextRequest.Builder biasPosition​(Double... biasPosition)

        An optional parameter that indicates a preference for places that are closer to a specified position.

        If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

        For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

        BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

        Parameters:
        biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.

        If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

        For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

        BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

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

      • filterBBox

        SearchPlaceIndexForTextRequest.Builder filterBBox​(Collection<Double> filterBBox)

        An optional parameter that limits the search results by returning only places that are within the provided bounding box.

        If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

        For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

        FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

        Parameters:
        filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.

        If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

        For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

        FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

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

      • filterBBox

        SearchPlaceIndexForTextRequest.Builder filterBBox​(Double... filterBBox)

        An optional parameter that limits the search results by returning only places that are within the provided bounding box.

        If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

        For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

        FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

        Parameters:
        filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.

        If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

        For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

        FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

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

      • filterCategories

        SearchPlaceIndexForTextRequest.Builder filterCategories​(Collection<String> filterCategories)

        A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

        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:
        filterCategories - A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

        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.

      • filterCategories

        SearchPlaceIndexForTextRequest.Builder filterCategories​(String... filterCategories)

        A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

        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:
        filterCategories - A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

        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.

      • filterCountries

        SearchPlaceIndexForTextRequest.Builder filterCountries​(Collection<String> filterCountries)

        An optional parameter that limits the search results by returning only places that are in a specified list of countries.

        • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

        Parameters:
        filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.

        • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

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

      • filterCountries

        SearchPlaceIndexForTextRequest.Builder filterCountries​(String... filterCountries)

        An optional parameter that limits the search results by returning only places that are in a specified list of countries.

        • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

        Parameters:
        filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.

        • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

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

      • indexName

        SearchPlaceIndexForTextRequest.Builder indexName​(String indexName)

        The name of the place index resource you want to use for the search.

        Parameters:
        indexName - The name of the place index resource you want to use for the search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • language

        SearchPlaceIndexForTextRequest.Builder language​(String language)

        The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

        This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

        For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

        If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

        If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

        Parameters:
        language - The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

        This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

        For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

        If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

        If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

      • maxResults

        SearchPlaceIndexForTextRequest.Builder maxResults​(Integer maxResults)

        An optional parameter. The maximum number of results returned per request.

        The default: 50

        Parameters:
        maxResults - An optional parameter. The maximum number of results returned per request.

        The default: 50

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

      • text

        SearchPlaceIndexForTextRequest.Builder text​(String text)

        The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

        Parameters:
        text - The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
        Returns:
        Returns a reference to this object so that method calls can be chained together.