@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchForSuggestionsResult extends Object implements Serializable, Cloneable, StructuredPojo
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
Constructor and Description |
---|
SearchForSuggestionsResult() |
Modifier and Type | Method and Description |
---|---|
SearchForSuggestionsResult |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCategories()
The Amazon Location categories that describe the Place.
|
String |
getPlaceId()
The unique identifier of the Place.
|
List<String> |
getSupplementalCategories()
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
String |
getText()
The text of the place suggestion, typically formatted as an address string.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCategories(Collection<String> categories)
The Amazon Location categories that describe the Place.
|
void |
setPlaceId(String placeId)
The unique identifier of the Place.
|
void |
setSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
void |
setText(String text)
The text of the place suggestion, typically formatted as an address string.
|
String |
toString()
Returns a string representation of this object.
|
SearchForSuggestionsResult |
withCategories(Collection<String> categories)
The Amazon Location categories that describe the Place.
|
SearchForSuggestionsResult |
withCategories(String... categories)
The Amazon Location categories that describe the Place.
|
SearchForSuggestionsResult |
withPlaceId(String placeId)
The unique identifier of the Place.
|
SearchForSuggestionsResult |
withSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
SearchForSuggestionsResult |
withSupplementalCategories(String... supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
SearchForSuggestionsResult |
withText(String text)
The text of the place suggestion, typically formatted as an address string.
|
public List<String> getCategories()
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.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public void setCategories(Collection<String> 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.
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.
public SearchForSuggestionsResult withCategories(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setCategories(java.util.Collection)
or withCategories(java.util.Collection)
if you want to
override the existing values.
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.
public SearchForSuggestionsResult withCategories(Collection<String> 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.
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.
public void setPlaceId(String 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 same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
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 same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
public String getPlaceId()
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 same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
GetPlace
operation to find the
place again later, or to get full information for the Place.
The GetPlace
request must use the same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
public SearchForSuggestionsResult withPlaceId(String 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 same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
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 same PlaceIndex
resource as the
SearchPlaceIndexForSuggestions
that generated the Place ID.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
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.
public List<String> getSupplementalCategories()
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
public void setSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public SearchForSuggestionsResult withSupplementalCategories(String... supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
NOTE: This method appends the values to the existing list (if any). Use
setSupplementalCategories(java.util.Collection)
or
withSupplementalCategories(java.util.Collection)
if you want to override the existing values.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public SearchForSuggestionsResult withSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public void setText(String text)
The text of the place suggestion, typically formatted as an address string.
text
- The text of the place suggestion, typically formatted as an address string.public String getText()
The text of the place suggestion, typically formatted as an address string.
public SearchForSuggestionsResult withText(String text)
The text of the place suggestion, typically formatted as an address string.
text
- The text of the place suggestion, typically formatted as an address string.public String toString()
toString
in class Object
Object.toString()
public SearchForSuggestionsResult clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.