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

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

Overview

A summary of the request sent by using ‘SearchPlaceIndexForText`.

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

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


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  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].

[1]: docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html

Returns:

  • (String) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#filter_b_box ⇒ Array<Float>

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

Returns:

  • (Array<Float>) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#filter_categories ⇒ Array<String>

The optional category filter specified in the request.

Returns:

  • (Array<String>) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#filter_countries ⇒ Array<String>

Contains the optional country filter specified in the request.

Returns:

  • (Array<String>) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  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.

[1]: tools.ietf.org/search/bcp47

Returns:

  • (String) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#max_results ⇒ Integer

Contains the optional result count limit specified in the request.

Returns:

  • (Integer) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#result_b_box ⇒ Array<Float>

The bounding box that fully contains all search results.

<note markdown=“1”> If you specified the optional ‘FilterBBox` parameter in the request, `ResultBBox` is contained within `FilterBBox`.

</note>

Returns:

  • (Array<Float>) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end

#text ⇒ String

The search text specified in the request.

Returns:

  • (String) 


6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/aws-sdk-locationservice/types.rb', line 6276

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, :result_b_box]
  include Aws::Structure
end