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

Class AutocompleteRequest

    • Method Detail

      • queryText

        public final 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.

        Returns:
        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.

      • maxResults

        public final Integer maxResults()

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

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

      • hasBiasPosition

        public final boolean hasBiasPosition()
        For responses, this returns true if the service returned a value for the BiasPosition property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • biasPosition

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBiasPosition() method.

        Returns:
        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.

      • filter

        public final AutocompleteFilter filter()

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

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

      • postalCodeMode

        public final PostalCodeMode postalCodeMode()

        The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value cityLookup, all cities in that postal code are returned.

        If the service returns an enum value that is not available in the current SDK version, postalCodeMode will return PostalCodeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeModeAsString().

        Returns:
        The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value cityLookup, all cities in that postal code are returned.
        See Also:
        PostalCodeMode

      • postalCodeModeAsString

        public final String postalCodeModeAsString()

        The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value cityLookup, all cities in that postal code are returned.

        If the service returns an enum value that is not available in the current SDK version, postalCodeMode will return PostalCodeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeModeAsString().

        Returns:
        The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value cityLookup, all cities in that postal code are returned.
        See Also:
        PostalCodeMode

      • additionalFeatures

        public final List<AutocompleteAdditionalFeature> additionalFeatures()

        A list of optional additional parameters that can be requested for each result.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalFeatures() method.

        Returns:
        A list of optional additional parameters that can be requested for each result.

      • hasAdditionalFeatures

        public final boolean hasAdditionalFeatures()
        For responses, this returns true if the service returned a value for the AdditionalFeatures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • additionalFeaturesAsStrings

        public final List<String> additionalFeaturesAsStrings()

        A list of optional additional parameters that can be requested for each result.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalFeatures() method.

        Returns:
        A list of optional additional parameters that can be requested for each result.

      • language

        public final 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.

        Returns:
        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.

      • politicalView

        public final 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.

        Returns:
        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.

      • intendedUseAsString

        public final String intendedUseAsString()

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

        If the service returns an enum value that is not available in the current SDK version, intendedUse will return AutocompleteIntendedUse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intendedUseAsString().

        Returns:
        Indicates if the results will be stored. Defaults to SingleUse, if left empty.
        See Also:
        AutocompleteIntendedUse

      • key

        public final 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.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object