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

Interface ReverseGeocodeRequest.Builder

    • Method Detail

      • queryPosition

        ReverseGeocodeRequest.Builder queryPosition​(Collection<Double> queryPosition)

        The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

        Parameters:
        queryPosition - The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryPosition

        ReverseGeocodeRequest.Builder queryPosition​(Double... queryPosition)

        The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

        Parameters:
        queryPosition - The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryRadius

        ReverseGeocodeRequest.Builder queryRadius​(Long queryRadius)

        The maximum distance in meters from the QueryPosition from which a result will be returned.

        Parameters:
        queryRadius - The maximum distance in meters from the QueryPosition from which a result will be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ReverseGeocodeRequest.Builder maxResults​(Integer maxResults)

        An optional limit for the number of results returned in a single call.

        Parameters:
        maxResults - An optional limit for the number of results returned in a single call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filter

        ReverseGeocodeRequest.Builder filter​(ReverseGeocodeFilter filter)

        A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

        Parameters:
        filter - A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalFeaturesWithStrings

        ReverseGeocodeRequest.Builder additionalFeaturesWithStrings​(Collection<String> additionalFeatures)

        A list of optional additional parameters, such as time zone that can be requested for each result.

        Parameters:
        additionalFeatures - A list of optional additional parameters, such as time zone that can be requested for each result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalFeaturesWithStrings

        ReverseGeocodeRequest.Builder additionalFeaturesWithStrings​(String... additionalFeatures)

        A list of optional additional parameters, such as time zone that can be requested for each result.

        Parameters:
        additionalFeatures - A list of optional additional parameters, such as time zone that can be requested for each result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalFeatures

        ReverseGeocodeRequest.Builder additionalFeatures​(Collection<ReverseGeocodeAdditionalFeature> additionalFeatures)

        A list of optional additional parameters, such as time zone that can be requested for each result.

        Parameters:
        additionalFeatures - A list of optional additional parameters, such as time zone that can be requested for each result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalFeatures

        ReverseGeocodeRequest.Builder additionalFeatures​(ReverseGeocodeAdditionalFeature... additionalFeatures)

        A list of optional additional parameters, such as time zone that can be requested for each result.

        Parameters:
        additionalFeatures - A list of optional additional parameters, such as time zone that can be requested for each result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • language

        ReverseGeocodeRequest.Builder language​(String language)

        A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

        Parameters:
        language - A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • politicalView

        ReverseGeocodeRequest.Builder politicalView​(String politicalView)

        The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

        Parameters:
        politicalView - The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • key

        ReverseGeocodeRequest.Builder key​(String key)

        Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

        Parameters:
        key - Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.