@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetPlaceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
GetPlaceRequest() |
Modifier and Type | Method and Description |
---|---|
GetPlaceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getIndexName()
The name of the place index resource that you want to use for the search.
|
String |
getKey()
The optional API key
to authorize the request.
|
String |
getLanguage()
The preferred language used to return results.
|
String |
getPlaceId()
The identifier of the place to find.
|
int |
hashCode() |
void |
setIndexName(String indexName)
The name of the place index resource that you want to use for the search.
|
void |
setKey(String key)
The optional API key
to authorize the request.
|
void |
setLanguage(String language)
The preferred language used to return results.
|
void |
setPlaceId(String placeId)
The identifier of the place to find.
|
String |
toString()
Returns a string representation of this object.
|
GetPlaceRequest |
withIndexName(String indexName)
The name of the place index resource that you want to use for the search.
|
GetPlaceRequest |
withKey(String key)
The optional API key
to authorize the request.
|
GetPlaceRequest |
withLanguage(String language)
The preferred language used to return results.
|
GetPlaceRequest |
withPlaceId(String placeId)
The identifier of the place to find.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setIndexName(String indexName)
The name of the place index resource that you want to use for the search.
indexName
- The name of the place index resource that you want to use for the search.public String getIndexName()
The name of the place index resource that you want to use for the search.
public GetPlaceRequest withIndexName(String indexName)
The name of the place index resource that you want to use for the search.
indexName
- The name of the place index resource that you want to use for the search.public void setKey(String key)
The optional API key to authorize the request.
key
- The optional API
key to authorize the request.public String getKey()
The optional API key to authorize the request.
public GetPlaceRequest withKey(String key)
The optional API key to authorize the request.
key
- The optional API
key to authorize the request.public void setLanguage(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.
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.
public String getLanguage()
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.
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.
public GetPlaceRequest withLanguage(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.
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.
public void setPlaceId(String placeId)
The identifier of the place to find.
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 identifier of the place to find.
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 identifier of the place to find.
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.
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 GetPlaceRequest withPlaceId(String placeId)
The identifier of the place to find.
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 identifier of the place to find.
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 toString()
toString
in class Object
Object.toString()
public GetPlaceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()