@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchPlaceIndexForSuggestionsSummary extends Object implements Serializable, Cloneable, StructuredPojo
A summary of the request sent by using SearchPlaceIndexForSuggestions
.
Constructor and Description |
---|
SearchPlaceIndexForSuggestionsSummary() |
Modifier and Type | Method and Description |
---|---|
SearchPlaceIndexForSuggestionsSummary |
clone() |
boolean |
equals(Object obj) |
List<Double> |
getBiasPosition()
Contains the coordinates for the optional bias position specified in the request.
|
String |
getDataSource()
The geospatial data provider attached to the place index resource specified in the request.
|
List<Double> |
getFilterBBox()
Contains the coordinates for the optional bounding box specified in the request.
|
List<String> |
getFilterCategories()
The optional category filter specified in the request.
|
List<String> |
getFilterCountries()
Contains the optional country filter specified in the request.
|
String |
getLanguage()
The preferred language used to return results.
|
Integer |
getMaxResults()
Contains the optional result count limit specified in the request.
|
String |
getText()
The free-form partial text input specified in the request.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBiasPosition(Collection<Double> biasPosition)
Contains the coordinates for the optional bias position specified in the request.
|
void |
setDataSource(String dataSource)
The geospatial data provider attached to the place index resource specified in the request.
|
void |
setFilterBBox(Collection<Double> filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
|
void |
setFilterCategories(Collection<String> filterCategories)
The optional category filter specified in the request.
|
void |
setFilterCountries(Collection<String> filterCountries)
Contains the optional country filter specified in the request.
|
void |
setLanguage(String language)
The preferred language used to return results.
|
void |
setMaxResults(Integer maxResults)
Contains the optional result count limit specified in the request.
|
void |
setText(String text)
The free-form partial text input specified in the request.
|
String |
toString()
Returns a string representation of this object.
|
SearchPlaceIndexForSuggestionsSummary |
withBiasPosition(Collection<Double> biasPosition)
Contains the coordinates for the optional bias position specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withBiasPosition(Double... biasPosition)
Contains the coordinates for the optional bias position specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withDataSource(String dataSource)
The geospatial data provider attached to the place index resource specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterBBox(Collection<Double> filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterBBox(Double... filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterCategories(Collection<String> filterCategories)
The optional category filter specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterCategories(String... filterCategories)
The optional category filter specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterCountries(Collection<String> filterCountries)
Contains the optional country filter specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withFilterCountries(String... filterCountries)
Contains the optional country filter specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withLanguage(String language)
The preferred language used to return results.
|
SearchPlaceIndexForSuggestionsSummary |
withMaxResults(Integer maxResults)
Contains the optional result count limit specified in the request.
|
SearchPlaceIndexForSuggestionsSummary |
withText(String text)
The free-form partial text input specified in the request.
|
public SearchPlaceIndexForSuggestionsSummary()
public void setText(String text)
The free-form partial text input specified in the request.
text
- The free-form partial text input specified in the request.public String getText()
The free-form partial text input specified in the request.
public SearchPlaceIndexForSuggestionsSummary withText(String text)
The free-form partial text input specified in the request.
text
- The free-form partial text input specified in the request.public List<Double> getBiasPosition()
Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
.
This parameter contains 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
.
public void setBiasPosition(Collection<Double> biasPosition)
Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
- Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
.
public SearchPlaceIndexForSuggestionsSummary withBiasPosition(Double... biasPosition)
Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
.
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
- Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
.
public SearchPlaceIndexForSuggestionsSummary withBiasPosition(Collection<Double> biasPosition)
Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
- Contains the coordinates for the optional bias position specified in the request.
This parameter contains 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
.
public List<Double> getFilterBBox()
Contains the coordinates for the optional bounding box specified in the request.
public void setFilterBBox(Collection<Double> filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
filterBBox
- Contains the coordinates for the optional bounding box specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterBBox(Double... filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
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
- Contains the coordinates for the optional bounding box specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterBBox(Collection<Double> filterBBox)
Contains the coordinates for the optional bounding box specified in the request.
filterBBox
- Contains the coordinates for the optional bounding box specified in the request.public List<String> getFilterCountries()
Contains the optional country filter specified in the request.
public void setFilterCountries(Collection<String> filterCountries)
Contains the optional country filter specified in the request.
filterCountries
- Contains the optional country filter specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterCountries(String... filterCountries)
Contains the optional country filter specified in the request.
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
- Contains the optional country filter specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterCountries(Collection<String> filterCountries)
Contains the optional country filter specified in the request.
filterCountries
- Contains the optional country filter specified in the request.public void setMaxResults(Integer maxResults)
Contains the optional result count limit specified in the request.
maxResults
- Contains the optional result count limit specified in the request.public Integer getMaxResults()
Contains the optional result count limit specified in the request.
public SearchPlaceIndexForSuggestionsSummary withMaxResults(Integer maxResults)
Contains the optional result count limit specified in the request.
maxResults
- Contains the optional result count limit specified in the request.public void setDataSource(String dataSource)
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
dataSource
- The geospatial data provider attached to the place index resource specified in the request. Values can be
one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
public String getDataSource()
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
public SearchPlaceIndexForSuggestionsSummary withDataSource(String dataSource)
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
dataSource
- The geospatial data provider attached to the place index resource specified in the request. Values can be
one of the following:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
public void setLanguage(String language)
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en
for English.
language
- The preferred language used to return results. Matches the language in the request. The value is a valid
BCP 47 language tag, for example, en
for
English.public String getLanguage()
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en
for English.
en
for
English.public SearchPlaceIndexForSuggestionsSummary withLanguage(String language)
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en
for English.
language
- The preferred language used to return results. Matches the language in the request. The value is a valid
BCP 47 language tag, for example, en
for
English.public List<String> getFilterCategories()
The optional category filter specified in the request.
public void setFilterCategories(Collection<String> filterCategories)
The optional category filter specified in the request.
filterCategories
- The optional category filter specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterCategories(String... filterCategories)
The optional category filter specified in the request.
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
- The optional category filter specified in the request.public SearchPlaceIndexForSuggestionsSummary withFilterCategories(Collection<String> filterCategories)
The optional category filter specified in the request.
filterCategories
- The optional category filter specified in the request.public String toString()
toString
in class Object
Object.toString()
public SearchPlaceIndexForSuggestionsSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.