Package software.amazon.awssdk.services.location.model

Interface SearchPlaceIndexForPositionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>, LocationRequest.Builder, SdkBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchPlaceIndexForPositionRequest
public static interface SearchPlaceIndexForPositionRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>

  • Method Details

    • indexName

      SearchPlaceIndexForPositionRequest.Builder indexName(String indexName)

      The name of the place index resource you want to use for the search.

      Parameters:
      indexName - The name of the place index resource you want to use for the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      SearchPlaceIndexForPositionRequest.Builder key(String key)

      The optional API key to authorize the request.

      Parameters:
      key - The optional API key to authorize the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • language

      SearchPlaceIndexForPositionRequest.Builder language(String language)

      The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

      This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

      For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

      If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

      If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

      Parameters:
      language - The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

      This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

      For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

      If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

      If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

    • maxResults

      SearchPlaceIndexForPositionRequest.Builder maxResults(Integer maxResults)

      An optional parameter. The maximum number of results returned per request.

      Default value: 50

      Parameters:
      maxResults - An optional parameter. The maximum number of results returned per request.

      Default value: 50

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

    • position

      SearchPlaceIndexForPositionRequest.Builder position(Collection<Double> position)

      Specifies the longitude and latitude of the position to query.

      This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

      Parameters:
      position - Specifies the longitude and latitude of the position to query.

      This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

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

    • position

      SearchPlaceIndexForPositionRequest.Builder position(Double... position)

      Specifies the longitude and latitude of the position to query.

      This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

      Parameters:
      position - Specifies the longitude and latitude of the position to query.

      This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

      For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

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

    • overrideConfiguration

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

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