Class: Aws::LocationService::Types::SearchForTextResult

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#distance ⇒ Float

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.

<note markdown=“1”> A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

</note>

Returns:

  • (Float) 


5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5668

class SearchForTextResult < Struct.new(
  :place,
  :distance,
  :relevance,
  :place_id)
  SENSITIVE = []
  include Aws::Structure
end

#place ⇒ Types::Place

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

Returns:



5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5668

class SearchForTextResult < Struct.new(
  :place,
  :distance,
  :relevance,
  :place_id)
  SENSITIVE = []
  include Aws::Structure
end

#place_id ⇒ String

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

<note markdown=“1”> For ‘SearchPlaceIndexForText` operations, the `PlaceId` is returned only by place indexes that use HERE or Grab as a data provider.

</note>

Returns:

  • (String) 


5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5668

class SearchForTextResult < Struct.new(
  :place,
  :distance,
  :relevance,
  :place_id)
  SENSITIVE = []
  include Aws::Structure
end

#relevance ⇒ Float

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:

  • (Float) 


5668
5669
5670
5671
5672
5673
5674
5675
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5668

class SearchForTextResult < Struct.new(
  :place,
  :distance,
  :relevance,
  :place_id)
  SENSITIVE = []
  include Aws::Structure
end