software.amazon.awssdk.services.location.model

Interface SearchForPositionResult.Builder

All Superinterfaces:

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

Enclosing class:

SearchForPositionResult

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

Method Summary

Modifier and Type	Method and Description
SearchForPositionResult.Builder	distance(Double distance) The distance in meters of a great-circle arc between the query position and the result.
default SearchForPositionResult.Builder	place(Consumer<Place.Builder> place) Details about the search result, such as its address and position.
SearchForPositionResult.Builder	place(Place place) Details about the search result, such as its address and position.

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

SearchForPositionResult.Builder distance(Double distance)

The distance in meters of a great-circle arc between the query position and the result.

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 query position and the result.

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

SearchForPositionResult.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 SearchForPositionResult.Builder place(Consumer<Place.Builder> place)

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

This is a convenience 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)