@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchPlaceIndexForSuggestionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
SearchPlaceIndexForSuggestionsRequest() |
| Modifier and Type | Method and Description |
|---|---|
SearchPlaceIndexForSuggestionsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<Double> |
getBiasPosition()
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
|
List<Double> |
getFilterBBox()
An optional parameter that limits the search results by returning only suggestions within a specified bounding
box.
|
List<String> |
getFilterCategories()
A list of one or more Amazon Location categories to filter the returned places.
|
List<String> |
getFilterCountries()
An optional parameter that limits the search results by returning only suggestions within the provided list of
countries.
|
String |
getIndexName()
The name of the place index resource 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.
|
Integer |
getMaxResults()
An optional parameter.
|
String |
getText()
The free-form partial text to use to generate place suggestions.
|
int |
hashCode() |
void |
setBiasPosition(Collection<Double> biasPosition)
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
|
void |
setFilterBBox(Collection<Double> filterBBox)
An optional parameter that limits the search results by returning only suggestions within a specified bounding
box.
|
void |
setFilterCategories(Collection<String> filterCategories)
A list of one or more Amazon Location categories to filter the returned places.
|
void |
setFilterCountries(Collection<String> filterCountries)
An optional parameter that limits the search results by returning only suggestions within the provided list of
countries.
|
void |
setIndexName(String indexName)
The name of the place index resource 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 |
setMaxResults(Integer maxResults)
An optional parameter.
|
void |
setText(String text)
The free-form partial text to use to generate place suggestions.
|
String |
toString()
Returns a string representation of this object.
|
SearchPlaceIndexForSuggestionsRequest |
withBiasPosition(Collection<Double> biasPosition)
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
|
SearchPlaceIndexForSuggestionsRequest |
withBiasPosition(Double... biasPosition)
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterBBox(Collection<Double> filterBBox)
An optional parameter that limits the search results by returning only suggestions within a specified bounding
box.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterBBox(Double... filterBBox)
An optional parameter that limits the search results by returning only suggestions within a specified bounding
box.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterCategories(Collection<String> filterCategories)
A list of one or more Amazon Location categories to filter the returned places.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterCategories(String... filterCategories)
A list of one or more Amazon Location categories to filter the returned places.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterCountries(Collection<String> filterCountries)
An optional parameter that limits the search results by returning only suggestions within the provided list of
countries.
|
SearchPlaceIndexForSuggestionsRequest |
withFilterCountries(String... filterCountries)
An optional parameter that limits the search results by returning only suggestions within the provided list of
countries.
|
SearchPlaceIndexForSuggestionsRequest |
withIndexName(String indexName)
The name of the place index resource you want to use for the search.
|
SearchPlaceIndexForSuggestionsRequest |
withKey(String key)
The optional API key
to authorize the request.
|
SearchPlaceIndexForSuggestionsRequest |
withLanguage(String language)
The preferred language used to return results.
|
SearchPlaceIndexForSuggestionsRequest |
withMaxResults(Integer maxResults)
An optional parameter.
|
SearchPlaceIndexForSuggestionsRequest |
withText(String text)
The free-form partial text to use to generate place suggestions.
|
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, withSdkRequestTimeoutpublic SearchPlaceIndexForSuggestionsRequest()
public void setIndexName(String indexName)
The name of the place index resource you want to use for the search.
indexName - The name of the place index resource you want to use for the search.public String getIndexName()
The name of the place index resource you want to use for the search.
public SearchPlaceIndexForSuggestionsRequest withIndexName(String indexName)
The name of the place index resource you want to use for the search.
indexName - The name of the place index resource you want to use for the search.public void setText(String text)
The free-form partial text to use to generate place suggestions. For example, eiffel tow.
text - The free-form partial text to use to generate place suggestions. For example, eiffel tow.public String getText()
The free-form partial text to use to generate place suggestions. For example, eiffel tow.
eiffel tow.public SearchPlaceIndexForSuggestionsRequest withText(String text)
The free-form partial text to use to generate place suggestions. For example, eiffel tow.
text - The free-form partial text to use to generate place suggestions. For example, eiffel tow.public List<Double> getBiasPosition()
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
latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in
an error.
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 latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options
results in an error.
public void setBiasPosition(Collection<Double> 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
latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in
an error.
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 latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options
results in an error.
public SearchPlaceIndexForSuggestionsRequest withBiasPosition(Double... 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
latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in
an error.
NOTE: This method appends the values to the existing list (if any). Use
setBiasPosition(java.util.Collection) or withBiasPosition(java.util.Collection) if you want to
override the existing values.
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 latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options
results in an error.
public SearchPlaceIndexForSuggestionsRequest withBiasPosition(Collection<Double> 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
latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in
an error.
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 latitude 49.2847.
BiasPosition and FilterBBox are mutually exclusive. Specifying both options
results in an error.
public List<Double> getFilterBBox()
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 and BiasPosition are mutually exclusive. Specifying both options results in
an error.
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 and BiasPosition are mutually exclusive. Specifying both options
results in an error.
public void setFilterBBox(Collection<Double> 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 and BiasPosition are mutually exclusive. Specifying both options results in
an error.
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 and BiasPosition are mutually exclusive. Specifying both options
results in an error.
public SearchPlaceIndexForSuggestionsRequest withFilterBBox(Double... 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 and BiasPosition are mutually exclusive. Specifying both options results in
an error.
NOTE: This method appends the values to the existing list (if any). Use
setFilterBBox(java.util.Collection) or withFilterBBox(java.util.Collection) if you want to
override the existing values.
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 and BiasPosition are mutually exclusive. Specifying both options
results in an error.
public SearchPlaceIndexForSuggestionsRequest withFilterBBox(Collection<Double> 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 and BiasPosition are mutually exclusive. Specifying both options results in
an error.
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 and BiasPosition are mutually exclusive. Specifying both options
results in an error.
public List<String> getFilterCountries()
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.
Use the ISO 3166 3-digit country code. For
example, Australia uses three upper-case characters: AUS.
public void setFilterCountries(Collection<String> 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.
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.
public SearchPlaceIndexForSuggestionsRequest withFilterCountries(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setFilterCountries(java.util.Collection) or withFilterCountries(java.util.Collection) if you
want to override the existing values.
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.
public SearchPlaceIndexForSuggestionsRequest withFilterCountries(Collection<String> 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.
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.
public void setMaxResults(Integer maxResults)
An optional parameter. The maximum number of results returned per request.
The default: 5
maxResults - An optional parameter. The maximum number of results returned per request.
The default: 5
public Integer getMaxResults()
An optional parameter. The maximum number of results returned per request.
The default: 5
The default: 5
public SearchPlaceIndexForSuggestionsRequest withMaxResults(Integer maxResults)
An optional parameter. The maximum number of results returned per request.
The default: 5
maxResults - An optional parameter. The maximum number of results returned per request.
The default: 5
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. 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 the
language parameter set to en. The results found will most likely be returned as
Athens, Greece.
If you set the language parameter to el, 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.
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 the language parameter set to en. The results found will most likely be
returned as Athens, Greece.
If you set the language parameter to el, 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.
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. 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 the
language parameter set to en. The results found will most likely be returned as
Athens, Greece.
If you set the language parameter to el, 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.
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 the language parameter set to en. The results found will most likely be
returned as Athens, Greece.
If you set the language parameter to el, 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.
public SearchPlaceIndexForSuggestionsRequest 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. 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 the
language parameter set to en. The results found will most likely be returned as
Athens, Greece.
If you set the language parameter to el, 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.
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 the language parameter set to en. The results found will most likely be
returned as Athens, Greece.
If you set the language parameter to el, 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.
public List<String> getFilterCategories()
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.
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 setFilterCategories(Collection<String> 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.
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.
public SearchPlaceIndexForSuggestionsRequest withFilterCategories(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setFilterCategories(java.util.Collection) or withFilterCategories(java.util.Collection) if you
want to override the existing values.
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.
public SearchPlaceIndexForSuggestionsRequest withFilterCategories(Collection<String> 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.
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.
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 SearchPlaceIndexForSuggestionsRequest withKey(String key)
The optional API key to authorize the request.
key - The optional API
key to authorize the request.public String toString()
toString in class ObjectObject.toString()public SearchPlaceIndexForSuggestionsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()