com.amazonaws.services.location.model

Class GetPlaceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.GetPlaceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetPlaceRequest	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 that you want to use for the search.
String	getKey() The optional API key to authorize the request.
String	getLanguage() The preferred language used to return results.
String	getPlaceId() The identifier of the place to find.
int	hashCode()
void	setIndexName(String indexName) The name of the place index resource that you want to use for the search.
void	setKey(String key) The optional API key to authorize the request.
void	setLanguage(String language) The preferred language used to return results.
void	setPlaceId(String placeId) The identifier of the place to find.
String	toString() Returns a string representation of this object.
GetPlaceRequest	withIndexName(String indexName) The name of the place index resource that you want to use for the search.
GetPlaceRequest	withKey(String key) The optional API key to authorize the request.
GetPlaceRequest	withLanguage(String language) The preferred language used to return results.
GetPlaceRequest	withPlaceId(String placeId) The identifier of the place to find.

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

GetPlaceRequest

public GetPlaceRequest()

Method Detail

setIndexName

public void setIndexName(String indexName)

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

Parameters:

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

getIndexName

public String getIndexName()

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

Returns:

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

withIndexName

public GetPlaceRequest withIndexName(String indexName)

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

Parameters:

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

Returns:

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

setPlaceId

public void setPlaceId(String placeId)

The identifier of the place to find.

Parameters:

placeId - The identifier of the place to find.

getPlaceId

public String getPlaceId()

The identifier of the place to find.

Returns:

The identifier of the place to find.

withPlaceId

public GetPlaceRequest withPlaceId(String placeId)

The identifier of the place to find.

Parameters:

placeId - The identifier of the place to find.

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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

withLanguage

public GetPlaceRequest 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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Returns:

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

setKey

public void setKey(String key)

The optional API key to authorize the request.

Parameters:

key - The optional API key to authorize the request.

getKey

public String getKey()

The optional API key to authorize the request.

Returns:

The optional API key to authorize the request.

withKey

public GetPlaceRequest withKey(String key)

The optional API key to authorize the request.

Parameters:

key - The optional API key to authorize the request.

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