Class: Aws::LocationService::Types::SearchPlaceIndexForSuggestionsSummary

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

Overview

A summary of the request sent by using SearchPlaceIndexForSuggestions.

Constant Summary collapse

SENSITIVE =
[:bias_position, :filter_b_box, :text]

Instance Attribute Summary collapse

Instance Attribute Details

#bias_positionArray<Float>

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

Returns:

  • (Array<Float>)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#data_sourceString

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

  • Esri

  • Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

  • (String)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#filter_b_boxArray<Float>

Contains the coordinates for the optional bounding box specified in the request.

Returns:

  • (Array<Float>)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#filter_countriesArray<String>

Contains the optional country filter specified in the request.

Returns:

  • (Array<String>)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#languageString

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Returns:

  • (String)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#max_resultsInteger

Contains the optional result count limit specified in the request.

Returns:

  • (Integer)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end

#textString

The free-form partial text input specified in the request.

Returns:

  • (String)


4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4654

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :bias_position,
  :data_source,
  :filter_b_box,
  :filter_countries,
  :language,
  :max_results,
  :text)
  SENSITIVE = [:bias_position, :filter_b_box, :text]
  include Aws::Structure
end