Class: Aws::LocationService::Types::GetPlaceRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:key]

Instance Attribute Summary collapse

Instance Attribute Details

#index_name ⇒ String

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

Returns:

  • (String) 


3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3907

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

#key ⇒ String

The optional API key to authorize the request.

Returns:

  • (String) 


3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3907

class GetPlaceRequest < Struct.new(
  :index_name,
  :place_id,
  :language,
  :key)
  SENSITIVE = [: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.

Returns:

  • (String) 


3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3907

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

#place_id ⇒ String

The identifier of the place to find.

Returns:

  • (String) 


3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3907

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