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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#distanceFloat

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:

  • (Float)


4364
4365
4366
4367
4368
4369
4370
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4364

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

#placeTypes::Place

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

Returns:



4364
4365
4366
4367
4368
4369
4370
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4364

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

#relevanceFloat

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.

Returns:

  • (Float)


4364
4365
4366
4367
4368
4369
4370
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4364

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