Interface AutocompleteRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<AutocompleteRequest.Builder,AutocompleteRequest>, GeoPlacesRequest.Builder, SdkBuilder<AutocompleteRequest.Builder,AutocompleteRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
AutocompleteRequest
@Mutable @NotThreadSafe public static interface AutocompleteRequest.Builder extends GeoPlacesRequest.Builder, SdkPojo, CopyableBuilder<AutocompleteRequest.Builder,AutocompleteRequest>

  • Method Details

    • queryText

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

      The fields QueryText, and QueryID are mutually exclusive.

      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.

      The fields QueryText, and QueryID are mutually exclusive.

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

    • maxResults

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

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

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

      AutocompleteRequest.Builder filter(AutocompleteFilter filter)

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

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

    • filter

      default AutocompleteRequest.Builder filter(Consumer<AutocompleteFilter.Builder> filter)

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

      This is a convenience method that creates an instance of the AutocompleteFilter.Builder avoiding the need to create one manually via AutocompleteFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(AutocompleteFilter).

      Parameters:
      filter - a consumer that will call methods on AutocompleteFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • postalCodeMode

      AutocompleteRequest.Builder postalCodeMode(String 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 EnumerateSpannedLocalities, all cities in that postal code are returned.

      Parameters:
      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 EnumerateSpannedLocalities, all cities in that postal code are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • postalCodeMode

      AutocompleteRequest.Builder postalCodeMode(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 EnumerateSpannedLocalities, all cities in that postal code are returned.

      Parameters:
      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 EnumerateSpannedLocalities, all cities in that postal code are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalFeaturesWithStrings

      AutocompleteRequest.Builder additionalFeaturesWithStrings(Collection<String> additionalFeatures)

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

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

    • additionalFeaturesWithStrings

      AutocompleteRequest.Builder additionalFeaturesWithStrings(String... additionalFeatures)

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

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

    • additionalFeatures

      AutocompleteRequest.Builder additionalFeatures(Collection<AutocompleteAdditionalFeature> additionalFeatures)

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

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

    • additionalFeatures

      AutocompleteRequest.Builder additionalFeatures(AutocompleteAdditionalFeature... additionalFeatures)

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

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

    • language

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

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

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

      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.

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

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

    • intendedUse

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

    • intendedUse

      AutocompleteRequest.Builder intendedUse(AutocompleteIntendedUse 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:

    • key

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

    • overrideConfiguration

      AutocompleteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      AutocompleteRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.