Class: Aws::LocationService::Types::SearchForPositionResult

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

Overview

Contains a search result from a position 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 query position and the result.

<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) 


5572
5573
5574
5575
5576
5577
5578
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5572

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

#place ⇒ Types::Place

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

Returns:



5572
5573
5574
5575
5576
5577
5578
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5572

class SearchForPositionResult < Struct.new(
  :place,
  :distance,
  :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 ‘SearchPlaceIndexForPosition` operations, the `PlaceId` is returned only by place indexes that use HERE or Grab as a data provider.

</note>

Returns:

  • (String) 


5572
5573
5574
5575
5576
5577
5578
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5572

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