Package software.amazon.awssdk.services.geoplaces.model

Class AutocompleteResultItem

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.AutocompleteResultItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>

@Generated("software.amazon.awssdk:codegen")
public final class AutocompleteResultItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>

A result matching the input query text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutocompleteResultItem.Builder

Method Summary

Modifier and Type	Method	Description
Address	address()	The address associated with this result.
static AutocompleteResultItem.Builder	builder()
Long	distance()	The distance in meters between the center of the search area and this result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
AutocompleteHighlights	highlights()	Indicates the starting and ending index of the place in the text query that match the found title.
String	language()	A list of BCP 47 compliant language codes for the results to be rendered in.
String	placeId()	The PlaceId of the place associated with this result.
PlaceType	placeType()	PlaceType describes the type of result entry returned.
String	placeTypeAsString()	PlaceType describes the type of result entry returned.
String	politicalView()	The alpha-2 or alpha-3 character code for the political view of a country.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutocompleteResultItem.Builder>	serializableBuilderClass()
String	title()	A formatted string for display when presenting this result to an end user.
AutocompleteResultItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

placeId

public final String placeId()

The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

Returns:

The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

placeType

public final PlaceType placeType()

PlaceType describes the type of result entry returned.

If the service returns an enum value that is not available in the current SDK version, placeType will return PlaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placeTypeAsString().

Returns:

PlaceType describes the type of result entry returned.

See Also:

PlaceType

placeTypeAsString

public final String placeTypeAsString()

PlaceType describes the type of result entry returned.

If the service returns an enum value that is not available in the current SDK version, placeType will return PlaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placeTypeAsString().

Returns:

PlaceType describes the type of result entry returned.

See Also:

PlaceType

title

public final String title()

A formatted string for display when presenting this result to an end user.

Returns:

A formatted string for display when presenting this result to an end user.

address

public final Address address()

The address associated with this result.

Returns:

The address associated with this result.

distance

public final Long distance()

The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

Returns:

The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

language

public final String language()

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

Returns:

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

politicalView

public final String politicalView()

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

Returns:

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

highlights

public final AutocompleteHighlights highlights()

Indicates the starting and ending index of the place in the text query that match the found title.

Returns:

Indicates the starting and ending index of the place in the text query that match the found title.

toBuilder

public AutocompleteResultItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>

builder

public static AutocompleteResultItem.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo