Class: Aws::LocationService::Types::SearchPlaceIndexForPositionSummary

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::SearchPlaceIndexForPositionSummary

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:position]

Instance Attribute Summary

• #data_source ⇒ String

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

• #language ⇒ String

  The preferred language used to return results.

• #max_results ⇒ Integer

  Contains the optional result count limit that is specified in the request.

• #position ⇒ Array<Float>

  The position specified in the request.

Instance Attribute Details

#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 5809

class SearchPlaceIndexForPositionSummary < Struct.new(
  :position,
  :max_results,
  :data_source,
  :language)
  SENSITIVE = [:position]
  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 5809

class SearchPlaceIndexForPositionSummary < Struct.new(
  :position,
  :max_results,
  :data_source,
  :language)
  SENSITIVE = [:position]
  include Aws::Structure
end

#max_results ⇒ Integer

Contains the optional result count limit that is specified in the request.

Default value: ‘50`

Returns:

• (Integer)

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

class SearchPlaceIndexForPositionSummary < Struct.new(
  :position,
  :max_results,
  :data_source,
  :language)
  SENSITIVE = [:position]
  include Aws::Structure
end

#position ⇒ Array<Float>

The position specified in the request.

Returns:

• (Array<Float>)

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

class SearchPlaceIndexForPositionSummary < Struct.new(
  :position,
  :max_results,
  :data_source,
  :language)
  SENSITIVE = [:position]
  include Aws::Structure
end