Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Location.Types.SearchForPositionResult

Description

Documentation

data SearchForPositionResult Source #

Contains a search result from a position search query that is run on a place index resource.

See: newSearchForPositionResult smart constructor.

Constructors

SearchForPositionResult'

Fields

placeId :: Maybe Text
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE as a data provider.
distance :: Double
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.
place :: Place
Details about the search result, such as its address and position.

Instances

Instances details

FromJSON SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Methods parseJSON :: Value -> Parser SearchForPositionResult # parseJSONList :: Value -> Parser [SearchForPositionResult] #
Generic SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Associated Types type Rep SearchForPositionResult :: Type -> Type # Methods from :: SearchForPositionResult -> Rep SearchForPositionResult x # to :: Rep SearchForPositionResult x -> SearchForPositionResult #
Show SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Methods showsPrec :: Int -> SearchForPositionResult -> ShowS # show :: SearchForPositionResult -> String # showList :: [SearchForPositionResult] -> ShowS #
NFData SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Methods rnf :: SearchForPositionResult -> () #
Eq SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Methods (==) :: SearchForPositionResult -> SearchForPositionResult -> Bool # (/=) :: SearchForPositionResult -> SearchForPositionResult -> Bool #
Hashable SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult Methods hashWithSalt :: Int -> SearchForPositionResult -> Int # hash :: SearchForPositionResult -> Int #
type Rep SearchForPositionResult Source #
Instance details Defined in Amazonka.Location.Types.SearchForPositionResult type Rep SearchForPositionResult = D1 ('MetaData "SearchForPositionResult" "Amazonka.Location.Types.SearchForPositionResult" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "SearchForPositionResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "placeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "distance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :: S1 ('MetaSel ('Just "place") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Place))))

newSearchForPositionResult Source #

Arguments

:: Double	`$sel:distance:SearchForPositionResult'`
-> Place	`$sel:place:SearchForPositionResult'`
-> SearchForPositionResult

Create a value of SearchForPositionResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:placeId:SearchForPositionResult', searchForPositionResult_placeId - The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

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

$sel:distance:SearchForPositionResult', searchForPositionResult_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.

$sel:place:SearchForPositionResult', searchForPositionResult_place - Details about the search result, such as its address and position.

searchForPositionResult_placeId :: Lens' SearchForPositionResult (Maybe Text) Source #

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

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

searchForPositionResult_distance :: Lens' SearchForPositionResult Double Source #

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.

searchForPositionResult_place :: Lens' SearchForPositionResult Place Source #

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