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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::SearchPlaceIndexForPositionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:position, :key]

Instance Attribute Summary

• #index_name ⇒ String

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

• #key ⇒ String

  The optional [API key] to authorize the request.

• #language ⇒ String

  The preferred language used to return results.

• #max_results ⇒ Integer

  An optional parameter.

• #position ⇒ Array<Float>

  Specifies the longitude and latitude of the position to query.

Instance Attribute Details

#index_name ⇒ String

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

Returns:

• (String)

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

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

#key ⇒ String

The optional [API key] to authorize the request.

[1]: docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html

Returns:

• (String)

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

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

#language ⇒ String

The preferred language used to return results. The value must be a valid [BCP 47] language tag, for example, ‘en` for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we’ll use the Greek language. You search for a location around Athens, Greece, with the ‘language` parameter set to `en`. The `city` in the results will most likely be returned as `Athens`.

If you set the ‘language` parameter to `el`, for Greek, then the `city` in the results will more likely be returned as `Αθήνα`.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

Returns:

• (String)

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

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

#max_results ⇒ Integer

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

Default value: ‘50`

Returns:

• (Integer)

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

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

#position ⇒ Array<Float>

Specifies the longitude and latitude of the position to query.

This parameter must contain 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 a position with longitude `-123.1174` and latitude `49.2847`.

Returns:

• (Array<Float>)

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

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