com.amazonaws.services.geo.model

Class SearchPlaceIndexForTextRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.geo.model.SearchPlaceIndexForTextRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchPlaceIndexForTextRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.

Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchPlaceIndexForTextRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.Double>	getBiasPosition() Searches for results closest to the given position.
java.util.List<java.lang.Double>	getFilterBBox() Filters the results by returning only Places within the provided bounding box.
java.util.List<java.lang.String>	getFilterCountries() Limits the search to the given a list of countries/regions.
java.lang.String	getIndexName() The name of the Place index resource you want to use for the search.
java.lang.Integer	getMaxResults() An optional parameter.
java.lang.String	getText() The address, name, city, or region to be used in the search.
int	hashCode()
void	setBiasPosition(java.util.Collection<java.lang.Double> biasPosition) Searches for results closest to the given position.
void	setFilterBBox(java.util.Collection<java.lang.Double> filterBBox) Filters the results by returning only Places within the provided bounding box.
void	setFilterCountries(java.util.Collection<java.lang.String> filterCountries) Limits the search to the given a list of countries/regions.
void	setIndexName(java.lang.String indexName) The name of the Place index resource you want to use for the search.
void	setMaxResults(java.lang.Integer maxResults) An optional parameter.
void	setText(java.lang.String text) The address, name, city, or region to be used in the search.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchPlaceIndexForTextRequest	withBiasPosition(java.util.Collection<java.lang.Double> biasPosition) Searches for results closest to the given position.
SearchPlaceIndexForTextRequest	withBiasPosition(java.lang.Double... biasPosition) Searches for results closest to the given position.
SearchPlaceIndexForTextRequest	withFilterBBox(java.util.Collection<java.lang.Double> filterBBox) Filters the results by returning only Places within the provided bounding box.
SearchPlaceIndexForTextRequest	withFilterBBox(java.lang.Double... filterBBox) Filters the results by returning only Places within the provided bounding box.
SearchPlaceIndexForTextRequest	withFilterCountries(java.util.Collection<java.lang.String> filterCountries) Limits the search to the given a list of countries/regions.
SearchPlaceIndexForTextRequest	withFilterCountries(java.lang.String... filterCountries) Limits the search to the given a list of countries/regions.
SearchPlaceIndexForTextRequest	withIndexName(java.lang.String indexName) The name of the Place index resource you want to use for the search.
SearchPlaceIndexForTextRequest	withMaxResults(java.lang.Integer maxResults) An optional parameter.
SearchPlaceIndexForTextRequest	withText(java.lang.String text) The address, name, city, or region to be used in the search.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchPlaceIndexForTextRequest

public SearchPlaceIndexForTextRequest()

Method Detail

getBiasPosition

public java.util.List<java.lang.Double> getBiasPosition()

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns:

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

setBiasPosition

public void setBiasPosition(java.util.Collection<java.lang.Double> biasPosition)

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Parameters:

biasPosition -

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

withBiasPosition

public SearchPlaceIndexForTextRequest withBiasPosition(java.lang.Double... biasPosition)

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns a reference to this object so that method calls can be chained together.

Parameters:

biasPosition -

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns:

A reference to this updated object so that method calls can be chained together.

withBiasPosition

public SearchPlaceIndexForTextRequest withBiasPosition(java.util.Collection<java.lang.Double> biasPosition)

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns a reference to this object so that method calls can be chained together.

Parameters:

biasPosition -

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilterBBox

public java.util.List<java.lang.Double> getFilterBBox()

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

setFilterBBox

public void setFilterBBox(java.util.Collection<java.lang.Double> filterBBox)

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Parameters:

filterBBox -

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

withFilterBBox

public SearchPlaceIndexForTextRequest withFilterBBox(java.lang.Double... filterBBox)

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns a reference to this object so that method calls can be chained together.

Parameters:

filterBBox -

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

A reference to this updated object so that method calls can be chained together.

withFilterBBox

public SearchPlaceIndexForTextRequest withFilterBBox(java.util.Collection<java.lang.Double> filterBBox)

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns a reference to this object so that method calls can be chained together.

Parameters:

filterBBox -

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

A reference to this updated object so that method calls can be chained together.

getFilterCountries

public java.util.List<java.lang.String> getFilterCountries()

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Returns:

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

setFilterCountries

public void setFilterCountries(java.util.Collection<java.lang.String> filterCountries)

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Parameters:

filterCountries -

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

withFilterCountries

public SearchPlaceIndexForTextRequest withFilterCountries(java.lang.String... filterCountries)

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filterCountries -

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilterCountries

public SearchPlaceIndexForTextRequest withFilterCountries(java.util.Collection<java.lang.String> filterCountries)

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filterCountries -

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Returns:

A reference to this updated object so that method calls can be chained together.

getIndexName

public java.lang.String getIndexName()

The name of the Place index resource you want to use for the search.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Returns:

The name of the Place index resource you want to use for the search.

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the Place index resource you want to use for the search.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Parameters:

indexName -

The name of the Place index resource you want to use for the search.

withIndexName

public SearchPlaceIndexForTextRequest withIndexName(java.lang.String indexName)

The name of the Place index resource you want to use for the search.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Parameters:

indexName -

The name of the Place index resource you want to use for the search.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

An optional parameter. The maximum number of results returned per request.

The default: 50

Constraints:
Range: 1 - 50

Returns:

An optional parameter. The maximum number of results returned per request.

The default: 50

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

An optional parameter. The maximum number of results returned per request.

The default: 50

Constraints:
Range: 1 - 50

Parameters:

maxResults -

An optional parameter. The maximum number of results returned per request.

The default: 50

withMaxResults

public SearchPlaceIndexForTextRequest withMaxResults(java.lang.Integer maxResults)

An optional parameter. The maximum number of results returned per request.

The default: 50

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 50

Parameters:

maxResults -

An optional parameter. The maximum number of results returned per request.

The default: 50

Returns:

A reference to this updated object so that method calls can be chained together.

getText

public java.lang.String getText()

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Constraints:
Length: 1 - 200

Returns:

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

setText

public void setText(java.lang.String text)

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Constraints:
Length: 1 - 200

Parameters:

text -

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

withText

public SearchPlaceIndexForTextRequest withText(java.lang.String text)

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 200

Parameters:

text -

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object