com.amazonaws.services.geo.model

Class SearchPlaceIndexForPositionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.geo.model.SearchPlaceIndexForPositionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchPlaceIndexForPositionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

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.

Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchPlaceIndexForPositionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getIndexName() The name of the Place index resource you want to use for the search.
java.lang.Integer	getMaxResults() An optional paramer.
java.util.List<java.lang.Double>	getPosition() Specifies a coordinate for the query defined by a longitude, and latitude.
int	hashCode()
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 paramer.
void	setPosition(java.util.Collection<java.lang.Double> position) Specifies a coordinate for the query defined by a longitude, and latitude.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchPlaceIndexForPositionRequest	withIndexName(java.lang.String indexName) The name of the Place index resource you want to use for the search.
SearchPlaceIndexForPositionRequest	withMaxResults(java.lang.Integer maxResults) An optional paramer.
SearchPlaceIndexForPositionRequest	withPosition(java.util.Collection<java.lang.Double> position) Specifies a coordinate for the query defined by a longitude, and latitude.
SearchPlaceIndexForPositionRequest	withPosition(java.lang.Double... position) Specifies a coordinate for the query defined by a longitude, and latitude.

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

SearchPlaceIndexForPositionRequest

public SearchPlaceIndexForPositionRequest()

Method Detail

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 SearchPlaceIndexForPositionRequest 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 paramer. The maximum number of results returned per request.

Default value: 50

Constraints:
Range: 1 - 50

Returns:

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

Default value: 50

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

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

Default value: 50

Constraints:
Range: 1 - 50

Parameters:

maxResults -

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

Default value: 50

withMaxResults

public SearchPlaceIndexForPositionRequest withMaxResults(java.lang.Integer maxResults)

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

Default value: 50

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

Constraints:
Range: 1 - 50

Parameters:

maxResults -

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

Default value: 50

Returns:

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

getPosition

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

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

Returns:

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

setPosition

public void setPosition(java.util.Collection<java.lang.Double> position)

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

Parameters:

position -

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

withPosition

public SearchPlaceIndexForPositionRequest withPosition(java.lang.Double... position)

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

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

Parameters:

position -

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

Returns:

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

withPosition

public SearchPlaceIndexForPositionRequest withPosition(java.util.Collection<java.lang.Double> position)

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

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

Parameters:

position -

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

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