Interface SearchPlaceIndexForSuggestionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchPlaceIndexForSuggestionsRequest.Builder,
,SearchPlaceIndexForSuggestionsRequest> LocationRequest.Builder
,SdkBuilder<SearchPlaceIndexForSuggestionsRequest.Builder,
,SearchPlaceIndexForSuggestionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchPlaceIndexForSuggestionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionbiasPosition
(Double... biasPosition) An optional parameter that indicates a preference for place suggestions that are closer to a specified position.biasPosition
(Collection<Double> biasPosition) An optional parameter that indicates a preference for place suggestions that are closer to a specified position.filterBBox
(Double... filterBBox) An optional parameter that limits the search results by returning only suggestions within a specified bounding box.filterBBox
(Collection<Double> filterBBox) An optional parameter that limits the search results by returning only suggestions within a specified bounding box.filterCategories
(String... filterCategories) A list of one or more Amazon Location categories to filter the returned places.filterCategories
(Collection<String> filterCategories) A list of one or more Amazon Location categories to filter the returned places.filterCountries
(String... filterCountries) An optional parameter that limits the search results by returning only suggestions within the provided list of countries.filterCountries
(Collection<String> filterCountries) An optional parameter that limits the search results by returning only suggestions within the provided list of countries.The name of the place index resource you want to use for the search.The optional API key to authorize the request.The preferred language used to return results.maxResults
(Integer maxResults) An optional parameter.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The free-form partial text to use to generate place suggestions.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
-
biasPosition
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
If provided, this parameter must contain 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 latitude49.2847
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.- Parameters:
biasPosition
- An optional parameter that indicates a preference for place suggestions that are closer to a specified position.If provided, this parameter must contain 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 latitude49.2847
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
biasPosition
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
If provided, this parameter must contain 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 latitude49.2847
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.- Parameters:
biasPosition
- An optional parameter that indicates a preference for place suggestions that are closer to a specified position.If provided, this parameter must contain 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 latitude49.2847
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterBBox
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.- Parameters:
filterBBox
- An optional parameter that limits the search results by returning only suggestions within a specified bounding box.If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterBBox
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.- Parameters:
filterBBox
- An optional parameter that limits the search results by returning only suggestions within a specified bounding box.If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterCategories
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
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:
filterCategories
- A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.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.
-
filterCategories
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
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:
filterCategories
- A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.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.
-
filterCountries
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
-
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters:
AUS
.
- Parameters:
filterCountries
- An optional parameter that limits the search results by returning only suggestions within the provided list of countries.-
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters:
AUS
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filterCountries
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
-
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters:
AUS
.
- Parameters:
filterCountries
- An optional parameter that limits the search results by returning only suggestions within the provided list of countries.-
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters:
AUS
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
indexName
The name of the place index resource you want to use for the search.
- Parameters:
indexName
- The name of the place index resource 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. 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
Athens, Gr
to get suggestions with thelanguage
parameter set toen
. The results found will most likely be returned asAthens, Greece
.If you set the
language
parameter toel
, for Greek, then the result found 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. 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
Athens, Gr
to get suggestions with thelanguage
parameter set toen
. The results found will most likely be returned asAthens, Greece
.If you set the
language
parameter toel
, for Greek, then the result found 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.
-
maxResults
An optional parameter. The maximum number of results returned per request.
The default:
5
- Parameters:
maxResults
- An optional parameter. The maximum number of results returned per request.The default:
5
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
text
The free-form partial text to use to generate place suggestions. For example,
eiffel tow
.- Parameters:
text
- The free-form partial text to use to generate place suggestions. For example,eiffel tow
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SearchPlaceIndexForSuggestionsRequest.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
SearchPlaceIndexForSuggestionsRequest.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.
-