Class: Aws::LocationService::Types::SearchForSuggestionsResult

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

Overview

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[:text, :place_id, :categories, :supplemental_categories]

Instance Attribute Summary collapse

Instance Attribute Details

#categories ⇒ Array<String>

The Amazon Location categories that describe the Place.

For more information about using categories, including a list of Amazon Location categories, see [Categories and filtering], in the *Amazon Location Service developer guide*.

[1]: docs.aws.amazon.com/location/previous/developerguide/category-filtering.html

Returns:

  • (Array<String>) 


5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5799

class SearchForSuggestionsResult < Struct.new(
  :text,
  :place_id,
  :categories,
  :supplemental_categories)
  SENSITIVE = [:text, :place_id, :categories, :supplemental_categories]
  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, or to get full information for the Place.

The ‘GetPlace` request must use the same `PlaceIndex` resource as the `SearchPlaceIndexForSuggestions` that generated the Place ID.

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

</note>

Returns:

  • (String) 


5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5799

class SearchForSuggestionsResult < Struct.new(
  :text,
  :place_id,
  :categories,
  :supplemental_categories)
  SENSITIVE = [:text, :place_id, :categories, :supplemental_categories]
  include Aws::Structure
end

#supplemental_categories ⇒ Array<String>

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

Returns:

  • (Array<String>) 


5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5799

class SearchForSuggestionsResult < Struct.new(
  :text,
  :place_id,
  :categories,
  :supplemental_categories)
  SENSITIVE = [:text, :place_id, :categories, :supplemental_categories]
  include Aws::Structure
end

#text ⇒ String

The text of the place suggestion, typically formatted as an address string.

Returns:

  • (String) 


5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5799

class SearchForSuggestionsResult < Struct.new(
  :text,
  :place_id,
  :categories,
  :supplemental_categories)
  SENSITIVE = [:text, :place_id, :categories, :supplemental_categories]
  include Aws::Structure
end