software.amazon.awssdk.services.location.model

Interface SearchForTextResult.Builder

All Superinterfaces:

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

Enclosing class:

SearchForTextResult

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

Method Summary

Modifier and Type	Method and Description
SearchForTextResult.Builder	distance(Double distance) The distance in meters of a great-circle arc between the bias position specified and the result.
default SearchForTextResult.Builder	place(Consumer<Place.Builder> place) Details about the search result, such as its address and position.
SearchForTextResult.Builder	place(Place place) Details about the search result, such as its address and position.
SearchForTextResult.Builder	placeId(String placeId) The unique identifier of the place.
SearchForTextResult.Builder	relevance(Double relevance) The relative confidence in the match for a result among the results returned.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

distance

SearchForTextResult.Builder distance(Double distance)

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

Parameters:

distance - The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

Returns:

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

place

SearchForTextResult.Builder place(Place place)

Details about the search result, such as its address and position.

Parameters:

place - Details about the search result, such as its address and position.

Returns:

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

place

default SearchForTextResult.Builder place(Consumer<Place.Builder> place)

Details about the search result, such as its address and position.

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

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

Parameters:

place - a consumer that will call methods on Place.Builder

Returns:

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

See Also:

place(Place)

placeId

SearchForTextResult.Builder placeId(String placeId)

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

Parameters:

placeId - The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

Returns:

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

relevance

SearchForTextResult.Builder relevance(Double relevance)

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri or Grab.

Parameters:

relevance - The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri or Grab.

Returns:

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