Interface SearchPlaceIndexForTextSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SearchPlaceIndexForTextSummary.Builder,SearchPlaceIndexForTextSummary>, SdkBuilder<SearchPlaceIndexForTextSummary.Builder,SearchPlaceIndexForTextSummary>, SdkPojo
Enclosing class:
SearchPlaceIndexForTextSummary

public static interface SearchPlaceIndexForTextSummary.Builder extends SdkPojo, CopyableBuilder<SearchPlaceIndexForTextSummary.Builder,SearchPlaceIndexForTextSummary>
  • Method Details

    • biasPosition

      Contains the coordinates for the optional bias position specified in the request.

      This parameter contains 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 the position with longitude -123.1174 and latitude 49.2847.

      Parameters:
      biasPosition - Contains the coordinates for the optional bias position specified in the request.

      This parameter contains 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 the position with longitude -123.1174 and latitude 49.2847.

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

      SearchPlaceIndexForTextSummary.Builder biasPosition(Double... biasPosition)

      Contains the coordinates for the optional bias position specified in the request.

      This parameter contains 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 the position with longitude -123.1174 and latitude 49.2847.

      Parameters:
      biasPosition - Contains the coordinates for the optional bias position specified in the request.

      This parameter contains 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 the position with longitude -123.1174 and latitude 49.2847.

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

      The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

      Parameters:
      dataSource - The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

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

      Contains the coordinates for the optional bounding box specified in the request.

      Parameters:
      filterBBox - Contains the coordinates for the optional bounding box specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterBBox

      Contains the coordinates for the optional bounding box specified in the request.

      Parameters:
      filterBBox - Contains the coordinates for the optional bounding box specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCategories

      SearchPlaceIndexForTextSummary.Builder filterCategories(Collection<String> filterCategories)

      The optional category filter specified in the request.

      Parameters:
      filterCategories - The optional category filter specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCategories

      SearchPlaceIndexForTextSummary.Builder filterCategories(String... filterCategories)

      The optional category filter specified in the request.

      Parameters:
      filterCategories - The optional category filter specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCountries

      SearchPlaceIndexForTextSummary.Builder filterCountries(Collection<String> filterCountries)

      Contains the optional country filter specified in the request.

      Parameters:
      filterCountries - Contains the optional country filter specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCountries

      SearchPlaceIndexForTextSummary.Builder filterCountries(String... filterCountries)

      Contains the optional country filter specified in the request.

      Parameters:
      filterCountries - Contains the optional country filter specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • language

      The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

      Parameters:
      language - The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxResults

      Contains the optional result count limit specified in the request.

      Parameters:
      maxResults - Contains the optional result count limit specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resultBBox

      The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

      Parameters:
      resultBBox - The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

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

      The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

      Parameters:
      resultBBox - The bounding box that fully contains all search results.

      If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

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

      The search text specified in the request.

      Parameters:
      text - The search text specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.