Class: Aws::LocationService::Types::SearchPlaceIndexForPositionRequest

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

Overview

Note:

When making an API call, you may pass SearchPlaceIndexForPositionRequest data as a hash:

{
  index_name: "ResourceName", # required
  max_results: 1,
  position: [1.0], # required
}

Constant Summary collapse

SENSITIVE =
[:position]

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The name of the place index resource you want to use for the search.

Returns:

  • (String)


4341
4342
4343
4344
4345
4346
4347
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4341

class SearchPlaceIndexForPositionRequest < Struct.new(
  :index_name,
  :max_results,
  :position)
  SENSITIVE = [:position]
  include Aws::Structure
end

#max_resultsInteger

An optional paramer. The maximum number of results returned per request.

Default value: 50

Returns:

  • (Integer)


4341
4342
4343
4344
4345
4346
4347
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4341

class SearchPlaceIndexForPositionRequest < Struct.new(
  :index_name,
  :max_results,
  :position)
  SENSITIVE = [:position]
  include Aws::Structure
end

#positionArray<Float>

Specifies a coordinate for the query defined by a longitude, and latitude.

  • The first position is the X coordinate, or longitude.

  • The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

Returns:

  • (Array<Float>)


4341
4342
4343
4344
4345
4346
4347
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4341

class SearchPlaceIndexForPositionRequest < Struct.new(
  :index_name,
  :max_results,
  :position)
  SENSITIVE = [:position]
  include Aws::Structure
end