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.SearchForTextResult

Description

Documentation

data SearchForTextResult Source #

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

See: newSearchForTextResult smart constructor.

Constructors

SearchForTextResult'

Fields

distance :: Maybe Double
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.
placeId :: Maybe Text
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 as a data provider.
relevance :: Maybe Double
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.
place :: Place
Details about the search result, such as its address and position.

Instances

Instances details

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

newSearchForTextResult Source #

Arguments

:: Place	`$sel:place:SearchForTextResult'`
-> SearchForTextResult

Create a value of SearchForTextResult 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:distance:SearchForTextResult', searchForTextResult_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.

$sel:placeId:SearchForTextResult', searchForTextResult_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 as a data provider.

$sel:relevance:SearchForTextResult', searchForTextResult_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.

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

searchForTextResult_distance :: Lens' SearchForTextResult (Maybe Double) Source #

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.

searchForTextResult_placeId :: Lens' SearchForTextResult (Maybe Text) Source #

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 as a data provider.

searchForTextResult_relevance :: Lens' SearchForTextResult (Maybe Double) Source #

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.

searchForTextResult_place :: Lens' SearchForTextResult Place Source #

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