Interface SearchNearbyRequest.Builder

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

  • Method Details

    • queryPosition

      SearchNearbyRequest.Builder queryPosition(Collection<Double> queryPosition)

      The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

      Parameters:
      queryPosition - The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryPosition

      SearchNearbyRequest.Builder queryPosition(Double... queryPosition)

      The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

      Parameters:
      queryPosition - The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryRadius

      SearchNearbyRequest.Builder queryRadius(Long queryRadius)

      The maximum distance in meters from the QueryPosition from which a result will be returned.

      The fields QueryText, and QueryID are mutually exclusive.

      Parameters:
      queryRadius - The maximum distance in meters from the QueryPosition from which a result will be returned.

      The fields QueryText, and QueryID are mutually exclusive.

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

    • maxResults

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

    • filter

      SearchNearbyRequest.Builder filter(SearchNearbyFilter 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 SearchNearbyRequest.Builder filter(Consumer<SearchNearbyFilter.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 SearchNearbyFilter.Builder avoiding the need to create one manually via SearchNearbyFilter.builder().

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

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

    • additionalFeaturesWithStrings

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

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

      SearchNearbyRequest.Builder additionalFeatures(Collection<SearchNearbyAdditionalFeature> 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

      SearchNearbyRequest.Builder additionalFeatures(SearchNearbyAdditionalFeature... 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

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

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

      SearchNearbyRequest.Builder intendedUse(String intendedUse)

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

      Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      Parameters:
      intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.

      Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. 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

      SearchNearbyRequest.Builder intendedUse(SearchNearbyIntendedUse intendedUse)

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

      Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      Parameters:
      intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.

      Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. 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:

    • nextToken

      SearchNearbyRequest.Builder nextToken(String nextToken)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

      Parameters:
      nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

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

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

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