com.amazonaws.services.location.model

Class SearchPlaceIndexForTextRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.SearchPlaceIndexForTextRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchPlaceIndexForTextRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchPlaceIndexForTextRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchPlaceIndexForTextRequest

public SearchPlaceIndexForTextRequest()

Method Detail

getBiasPosition

public List<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(Collection<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(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.

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.

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:

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

withBiasPosition

public SearchPlaceIndexForTextRequest withBiasPosition(Collection<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.

Returns:

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

getFilterBBox

public List<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(Collection<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(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

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.

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:

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

withFilterBBox

public SearchPlaceIndexForTextRequest withFilterBBox(Collection<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

Returns:

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

getFilterCountries

public List<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(Collection<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(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.

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.

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:

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

withFilterCountries

public SearchPlaceIndexForTextRequest withFilterCountries(Collection<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.

Returns:

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

setIndexName

public void setIndexName(String 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.

getIndexName

public String getIndexName()

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

Returns:

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

withIndexName

public SearchPlaceIndexForTextRequest withIndexName(String 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.

setMaxResults

public void setMaxResults(Integer maxResults)

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

The default: 50

Parameters:

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

The default: 50

getMaxResults

public Integer getMaxResults()

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

The default: 50

Returns:

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

The default: 50

withMaxResults

public SearchPlaceIndexForTextRequest withMaxResults(Integer maxResults)

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

The default: 50

Parameters:

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

The default: 50

Returns:

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

setText

public void setText(String text)

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

Parameters:

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

getText

public String getText()

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

Returns:

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(String text)

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

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:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchPlaceIndexForTextRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()