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

Interface AutocompleteResultItem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>, SdkBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>, SdkPojo

Enclosing class:

AutocompleteResultItem

public static interface AutocompleteResultItem.Builder
extends SdkPojo, CopyableBuilder<AutocompleteResultItem.Builder,AutocompleteResultItem>

Method Summary

Modifier and Type	Method	Description
default AutocompleteResultItem.Builder	address(Consumer<Address.Builder> address)	The address associated with this result.
AutocompleteResultItem.Builder	address(Address address)	The address associated with this result.
AutocompleteResultItem.Builder	distance(Long distance)	The distance in meters between the center of the search area and this result.
default AutocompleteResultItem.Builder	highlights(Consumer<AutocompleteHighlights.Builder> highlights)	Indicates the starting and ending index of the place in the text query that match the found title.
AutocompleteResultItem.Builder	highlights(AutocompleteHighlights highlights)	Indicates the starting and ending index of the place in the text query that match the found title.
AutocompleteResultItem.Builder	language(String language)	A list of BCP 47 compliant language codes for the results to be rendered in.
AutocompleteResultItem.Builder	placeId(String placeId)	The PlaceId of the place associated with this result.
AutocompleteResultItem.Builder	placeType(String placeType)	PlaceType describes the type of result entry returned.
AutocompleteResultItem.Builder	placeType(PlaceType placeType)	PlaceType describes the type of result entry returned.
AutocompleteResultItem.Builder	politicalView(String politicalView)	The alpha-2 or alpha-3 character code for the political view of a country.
AutocompleteResultItem.Builder	title(String title)	A formatted string for display when presenting this result to an end user.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

placeId

AutocompleteResultItem.Builder placeId(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.

Parameters:

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:

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

placeType

AutocompleteResultItem.Builder placeType(String placeType)

PlaceType describes the type of result entry returned.

Parameters:

placeType - PlaceType describes the type of result entry returned.

Returns:

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

See Also:

PlaceType, PlaceType

placeType

AutocompleteResultItem.Builder placeType(PlaceType placeType)

PlaceType describes the type of result entry returned.

Parameters:

placeType - PlaceType describes the type of result entry returned.

Returns:

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

See Also:

PlaceType, PlaceType

title

AutocompleteResultItem.Builder title(String title)

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

Parameters:

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

Returns:

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

address

AutocompleteResultItem.Builder address(Address address)

The address associated with this result.

Parameters:

address - The address associated with this result.

Returns:

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

address

default AutocompleteResultItem.Builder address(Consumer<Address.Builder> address)

The address associated with this result.

This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to address(Address).

Parameters:

address - a consumer that will call methods on Address.Builder

Returns:

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

See Also:

address(Address)

distance

AutocompleteResultItem.Builder distance(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.

Parameters:

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:

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

language

AutocompleteResultItem.Builder language(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.

Parameters:

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:

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

politicalView

AutocompleteResultItem.Builder politicalView(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.

Parameters:

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:

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

highlights

AutocompleteResultItem.Builder highlights(AutocompleteHighlights highlights)

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

Parameters:

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

Returns:

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

highlights

default AutocompleteResultItem.Builder highlights(Consumer<AutocompleteHighlights.Builder> highlights)

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

This is a convenience method that creates an instance of the AutocompleteHighlights.Builder avoiding the need to create one manually via AutocompleteHighlights.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to highlights(AutocompleteHighlights).

Parameters:

highlights - a consumer that will call methods on AutocompleteHighlights.Builder

Returns:

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

See Also:

highlights(AutocompleteHighlights)