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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::SearchPlaceIndexForTextSummary

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

A summary of the request sent by using SearchPlaceIndexForText.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:text, :bias_position, :filter_b_box, :filter_countries, :result_b_box, :filter_categories]

Instance Attribute Summary

• #bias_position ⇒ Array<Float>

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

• #data_source ⇒ String

  The geospatial data provider attached to the place index resource specified in the request.

• #filter_b_box ⇒ Array<Float>

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

• #filter_categories ⇒ Array<String>

  The optional category filter specified in the request.

• #filter_countries ⇒ Array<String>

  Contains the optional country filter specified in the request.

• #language ⇒ String

  The preferred language used to return results.

• #max_results ⇒ Integer

  Contains the optional result count limit specified in the request.

• #result_b_box ⇒ Array<Float>

  The bounding box that fully contains all search results.

• #text ⇒ String

  The search text specified in the request.

Instance Attribute Details

#bias_position ⇒ Array<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>)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#data_source ⇒ String

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

• Esri

• Grab

• Here

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

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#filter_b_box ⇒ Array<Float>

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

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#filter_categories ⇒ Array<String>

The optional category filter specified in the request.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#filter_countries ⇒ Array<String>

Contains the optional country filter specified in the request.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#language ⇒ String

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)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#max_results ⇒ Integer

Contains the optional result count limit specified in the request.

Returns:

• (Integer)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#result_b_box ⇒ Array<Float>

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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

#text ⇒ String

The search text specified in the request.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6837

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