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

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

Overview

A summary of the request sent by using SearchPlaceIndexForPosition.

Constant Summary collapse

SENSITIVE =
[:position]

Instance Attribute Summary collapse

Instance Attribute Details

#data_sourceString

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)


5488
5489
5490
5491
5492
5493
5494
5495
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5488

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

#languageString

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)


5488
5489
5490
5491
5492
5493
5494
5495
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5488

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

#max_resultsInteger

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

Default value: 50

Returns:

  • (Integer)


5488
5489
5490
5491
5492
5493
5494
5495
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5488

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

#positionArray<Float>

The position specified in the request.

Returns:

  • (Array<Float>)


5488
5489
5490
5491
5492
5493
5494
5495
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5488

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