Interface SearchForSuggestionsResult.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SearchForSuggestionsResult.Builder,
,SearchForSuggestionsResult> SdkBuilder<SearchForSuggestionsResult.Builder,
,SearchForSuggestionsResult> SdkPojo
- Enclosing class:
SearchForSuggestionsResult
-
Method Summary
Modifier and TypeMethodDescriptioncategories
(String... categories) The Amazon Location categories that describe the Place.categories
(Collection<String> categories) The Amazon Location categories that describe the Place.The unique identifier of the Place.supplementalCategories
(String... supplementalCategories) Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.supplementalCategories
(Collection<String> supplementalCategories) Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.The text of the place suggestion, typically formatted as an address string.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
categories
The Amazon Location categories that describe the Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
- Parameters:
categories
- The Amazon Location categories that describe the Place.For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categories
The Amazon Location categories that describe the Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
- Parameters:
categories
- The Amazon Location categories that describe the Place.For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placeId
The unique identifier of the Place. You can use this with the
GetPlace
operation to find the place again later, or to get full information for the Place.The
GetPlace
request must use the samePlaceIndex
resource as theSearchPlaceIndexForSuggestions
that generated the Place ID.For
SearchPlaceIndexForSuggestions
operations, thePlaceId
is returned by place indexes that use Esri, Grab, or HERE as data providers.While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:
-
Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
-
HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.
-
Grab: Place IDs can expire or become invalid in the following situations.
-
Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
-
Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the
place.result_type
field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
-
- Parameters:
placeId
- The unique identifier of the Place. You can use this with theGetPlace
operation to find the place again later, or to get full information for the Place.The
GetPlace
request must use the samePlaceIndex
resource as theSearchPlaceIndexForSuggestions
that generated the Place ID.For
SearchPlaceIndexForSuggestions
operations, thePlaceId
is returned by place indexes that use Esri, Grab, or HERE as data providers.While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:
-
Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
-
HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.
-
Grab: Place IDs can expire or become invalid in the following situations.
-
Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
-
Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the
place.result_type
field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
supplementalCategories
SearchForSuggestionsResult.Builder supplementalCategories(Collection<String> supplementalCategories) Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
- Parameters:
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
supplementalCategories
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
- Parameters:
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
text
The text of the place suggestion, typically formatted as an address string.
- Parameters:
text
- The text of the place suggestion, typically formatted as an address string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-