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

Interface GeocodeRequest.Builder

    • Method Detail

      • queryText

        GeocodeRequest.Builder queryText​(String queryText)

        The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

        Parameters:
        queryText - The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryComponents

        GeocodeRequest.Builder queryComponents​(GeocodeQueryComponents queryComponents)
        Sets the value of the QueryComponents property for this object.
        Parameters:
        queryComponents - The new value for the QueryComponents property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        GeocodeRequest.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.

      • biasPosition

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

        The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

        The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

        Parameters:
        biasPosition - The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

        The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

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

      • biasPosition

        GeocodeRequest.Builder biasPosition​(Double... biasPosition)

        The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

        The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

        Parameters:
        biasPosition - The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

        The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

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

      • filter

        GeocodeRequest.Builder filter​(GeocodeFilter 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

        GeocodeRequest.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

        GeocodeRequest.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

        GeocodeRequest.Builder additionalFeatures​(Collection<GeocodeAdditionalFeature> 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

        GeocodeRequest.Builder additionalFeatures​(GeocodeAdditionalFeature... 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

        GeocodeRequest.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

        GeocodeRequest.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.

      • intendedUse

        GeocodeRequest.Builder intendedUse​(String intendedUse)

        Indicates if the results will be stored. Defaults to SingleUse, if left empty.

        Parameters:
        intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GeocodeIntendedUse, GeocodeIntendedUse

      • intendedUse

        GeocodeRequest.Builder intendedUse​(GeocodeIntendedUse intendedUse)

        Indicates if the results will be stored. Defaults to SingleUse, if left empty.

        Parameters:
        intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GeocodeIntendedUse, GeocodeIntendedUse

      • key

        GeocodeRequest.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.