Interface GeocodeRequest.Builder

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

  • Method Details

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

    • queryComponents

      default GeocodeRequest.Builder queryComponents(Consumer<GeocodeQueryComponents.Builder> queryComponents)
      Sets the value of the QueryComponents property for this object. This is a convenience method that creates an instance of the GeocodeQueryComponents.Builder avoiding the need to create one manually via GeocodeQueryComponents.builder().

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

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

    • maxResults

      GeocodeRequest.Builder maxResults(Integer maxResults)

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

      Default value: 20

      Parameters:
      maxResults - An optional limit for the number of results returned in a single call.

      Default value: 20

      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 WGS 84 format.

      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 WGS 84 format.
      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 WGS 84 format.

      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 WGS 84 format.
      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 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 GeocodeRequest.Builder filter(Consumer<GeocodeFilter.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 GeocodeFilter.Builder avoiding the need to create one manually via GeocodeFilter.builder().

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

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

    • 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 query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      Parameters:
      intendedUse - Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

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

    • intendedUse

      GeocodeRequest.Builder intendedUse(GeocodeIntendedUse intendedUse)

      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      Parameters:
      intendedUse - Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

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

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

    • postalCodeMode

      GeocodeRequest.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. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names 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. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • postalCodeMode

      GeocodeRequest.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. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names 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. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressTranslationsWithStrings

      GeocodeRequest.Builder addressTranslationsWithStrings(Collection<String> addressTranslations)

      Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.

      Parameters:
      addressTranslations - Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressTranslationsWithStrings

      GeocodeRequest.Builder addressTranslationsWithStrings(String... addressTranslations)

      Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.

      Parameters:
      addressTranslations - Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressTranslations

      GeocodeRequest.Builder addressTranslations(Collection<AddressTranslationComponent> addressTranslations)

      Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.

      Parameters:
      addressTranslations - Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressTranslations

      GeocodeRequest.Builder addressTranslations(AddressTranslationComponent... addressTranslations)

      Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.

      Parameters:
      addressTranslations - Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressNamesMode

      GeocodeRequest.Builder addressNamesMode(String addressNamesMode)

      Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.

      Parameters:
      addressNamesMode - Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressNamesMode

      GeocodeRequest.Builder addressNamesMode(GeocodeAddressNamesMode addressNamesMode)

      Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.

      Parameters:
      addressNamesMode - Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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