Interface GetPlaceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetPlaceRequest.Builder,
,GetPlaceRequest> LocationRequest.Builder
,SdkBuilder<GetPlaceRequest.Builder,
,GetPlaceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetPlaceRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the place index resource that you want to use for the search.The optional API key to authorize the request.The preferred language used to return results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The identifier of the place to find.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder
build
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
-
indexName
The name of the place index resource that you want to use for the search.
- Parameters:
indexName
- The name of the place index resource that you want to use for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
key
The optional API key to authorize the request.
- Parameters:
key
- The optional API key to authorize 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. 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 toen
. Thecity
in the results will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then thecity
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.
- Parameters:
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 toen
. Thecity
in the results will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then thecity
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
- Parameters:
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.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
GetPlaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetPlaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-