com.amazonaws.services.location.model

Class SearchPlaceIndexForPositionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.SearchPlaceIndexForPositionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchPlaceIndexForPositionRequest
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
SearchPlaceIndexForPositionRequest()

Method Summary

Modifier and Type	Method and Description
SearchPlaceIndexForPositionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIndexName() The name of the place index resource you want to use for the search.
String	getLanguage() The preferred language used to return results.
Integer	getMaxResults() An optional parameter.
List<Double>	getPosition() Specifies the longitude and latitude of the position to query.
int	hashCode()
void	setIndexName(String indexName) The name of the place index resource you want to use for the search.
void	setLanguage(String language) The preferred language used to return results.
void	setMaxResults(Integer maxResults) An optional parameter.
void	setPosition(Collection<Double> position) Specifies the longitude and latitude of the position to query.
String	toString() Returns a string representation of this object.
SearchPlaceIndexForPositionRequest	withIndexName(String indexName) The name of the place index resource you want to use for the search.
SearchPlaceIndexForPositionRequest	withLanguage(String language) The preferred language used to return results.
SearchPlaceIndexForPositionRequest	withMaxResults(Integer maxResults) An optional parameter.
SearchPlaceIndexForPositionRequest	withPosition(Collection<Double> position) Specifies the longitude and latitude of the position to query.
SearchPlaceIndexForPositionRequest	withPosition(Double... position) Specifies the longitude and latitude of the position to query.

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

SearchPlaceIndexForPositionRequest

public SearchPlaceIndexForPositionRequest()

Method Detail

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 SearchPlaceIndexForPositionRequest 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.

setLanguage

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

Parameters:

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

getLanguage

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

Returns:

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

withLanguage

public SearchPlaceIndexForPositionRequest 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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

Parameters:

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

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.

Default value: 50

Parameters:

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

Default value: 50

getMaxResults

public Integer getMaxResults()

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

Default value: 50

Returns:

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

Default value: 50

withMaxResults

public SearchPlaceIndexForPositionRequest withMaxResults(Integer maxResults)

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

Default value: 50

Parameters:

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

Default value: 50

Returns:

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

getPosition

public List<Double> getPosition()

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

Returns:

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

setPosition

public void setPosition(Collection<Double> position)

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

Parameters:

position - Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

withPosition

public SearchPlaceIndexForPositionRequest withPosition(Double... position)

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

NOTE: This method appends the values to the existing list (if any). Use setPosition(java.util.Collection) or withPosition(java.util.Collection) if you want to override the existing values.

Parameters:

position - Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

Returns:

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

withPosition

public SearchPlaceIndexForPositionRequest withPosition(Collection<Double> position)

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

Parameters:

position - Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.

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 SearchPlaceIndexForPositionRequest 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()