Class: Aws::LocationService::Types::SearchPlaceIndexForTextSummary

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

Overview

A summary of the geocoding request sent using SearchPlaceIndexForText.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#bias_positionArray<Float>

Contains the coordinates for the bias position entered in the geocoding request.

Returns:

  • (Array<Float>)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#data_sourceString

The data provider of geospatial data. Indicates one of the available providers:

  • Esri

  • HERE

For additional details on data providers, see the Amazon Location Service data providers page.

Returns:

  • (String)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#filter_b_boxArray<Float>

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

Returns:

  • (Array<Float>)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#filter_countriesArray<String>

Contains the country filter entered in the geocoding request.

Returns:

  • (Array<String>)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#max_resultsInteger

Contains the maximum number of results indicated for the request.

Returns:

  • (Integer)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#result_b_boxArray<Float>

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

Returns:

  • (Array<Float>)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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

#textString

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.

Returns:

  • (String)


4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4537

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