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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::SearchPlaceIndexForSuggestionsSummary

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:text, :bias_position, :filter_b_box]

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.

• #text ⇒ String

  The free-form partial text input 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 6033

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_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)

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

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_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>)

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

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_b_box]
  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 6033

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_b_box]
  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 6033

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_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)

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

class SearchPlaceIndexForSuggestionsSummary < Struct.new(
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :data_source,
  :language,
  :filter_categories)
  SENSITIVE = [:text, :bias_position, :filter_b_box]
  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 6033

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

#text ⇒ String

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

Returns:

• (String)

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

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