Package software.amazon.awssdk.services.location.model

Class GetPlaceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.GetPlaceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPlaceRequest.Builder,GetPlaceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetPlaceRequest
extends LocationRequest
implements ToCopyableBuilder<GetPlaceRequest.Builder,GetPlaceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetPlaceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetPlaceRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName()	The name of the place index resource that you want to use for the search.
String	key()	The optional API key to authorize the request.
String	language()	The preferred language used to return results.
String	placeId()	The identifier of the place to find.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPlaceRequest.Builder>	serializableBuilderClass()
GetPlaceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

indexName

public final String indexName()

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.

placeId

public final String placeId()

The identifier of the place to find.

Returns:

The identifier of the place to find.

language

public final 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.

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.

key

public final String key()

The optional API key to authorize the request.

Returns:

The optional API key to authorize the request.

toBuilder

public GetPlaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPlaceRequest.Builder,GetPlaceRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static GetPlaceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetPlaceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo