Class: Aws::GeoPlaces::Types::SuggestPlaceResult

Inherits:

Struct

Object
Struct
Aws::GeoPlaces::Types::SuggestPlaceResult

show all

Defined in:: gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb

Overview

The suggested place results.

Constant Summary collapse

SENSITIVE =

[:place_id, :place_type, :position, :distance, :map_view, :political_view]

Instance Attribute Summary collapse

#access_points ⇒ Array<Types::AccessPoint>
Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
#access_restrictions ⇒ Array<Types::AccessRestriction>
Indicates known access restrictions on a vehicle access point.
#address ⇒ Types::Address
The place's address.
#business_chains ⇒ Array<Types::BusinessChain>
The Business Chains associated with the place.
#categories ⇒ Array<Types::Category>
Categories of results that results must belong to.
#distance ⇒ Integer
The distance in meters from the QueryPosition.
#food_types ⇒ Array<Types::FoodType>
List of food types offered by this result.
#map_view ⇒ Array<Float>
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
#phonemes ⇒ Types::PhonemeDetails
How the various components of the result's address are pronounced in various languages.
#place_id ⇒ String
The PlaceId of the place you wish to receive the information for.
#place_type ⇒ String
A PlaceType is a category that the result place must belong to.
#political_view ⇒ String
The alpha-2 or alpha-3 character code for the political view of a country.
#position ⇒ Array<Float>
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
#time_zone ⇒ Types::TimeZone
The time zone in which the place is located.

Instance Attribute Details

#access_points ⇒ `Array<Types::AccessPoint>`

Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].

Returns:

(Array<Types::AccessPoint>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#access_restrictions ⇒ `Array<Types::AccessRestriction>`

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

Returns:

(Array<Types::AccessRestriction>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#address ⇒ `Types::Address`

The place's address.

Returns:

(Types::Address)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#business_chains ⇒ `Array<Types::BusinessChain>`

The Business Chains associated with the place.

Returns:

(Array<Types::BusinessChain>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#categories ⇒ `Array<Types::Category>`

Categories of results that results must belong to.

Returns:

(Array<Types::Category>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#distance ⇒ `Integer`

The distance in meters from the QueryPosition.

Returns:

(Integer)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#food_types ⇒ `Array<Types::FoodType>`

List of food types offered by this result.

Returns:

(Array<Types::FoodType>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#map_view ⇒ `Array<Float>`

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

Returns:

(Array<Float>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#phonemes ⇒ `Types::PhonemeDetails`

How the various components of the result's address are pronounced in various languages.

Returns:

(Types::PhonemeDetails)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#place_id ⇒ `String`

The PlaceId of the place you wish to receive the information for.

Returns:

(String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#place_type ⇒ `String`

A PlaceType is a category that the result place must belong to.

Returns:

(String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#political_view ⇒ `String`

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

Returns:

(String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#position ⇒ `Array<Float>`

The position in World Geodetic System (WGS 84) format: [longitude, latitude].

Returns:

(Array<Float>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

#time_zone ⇒ `Types::TimeZone`

The time zone in which the place is located.

Returns:

(Types::TimeZone)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 3103

class SuggestPlaceResult < Struct.new(
  :place_id,
  :place_type,
  :address,
  :position,
  :distance,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes)
  SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
  include Aws::Structure
end

Class: Aws::GeoPlaces::Types::SuggestPlaceResult

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_points ⇒ Array<Types::AccessPoint>

#access_restrictions ⇒ Array<Types::AccessRestriction>

#address ⇒ Types::Address

#business_chains ⇒ Array<Types::BusinessChain>

#categories ⇒ Array<Types::Category>

#distance ⇒ Integer

#food_types ⇒ Array<Types::FoodType>

#map_view ⇒ Array<Float>

#phonemes ⇒ Types::PhonemeDetails

#place_id ⇒ String

#place_type ⇒ String

#political_view ⇒ String

#position ⇒ Array<Float>

#time_zone ⇒ Types::TimeZone

#access_points ⇒ `Array<Types::AccessPoint>`

#access_restrictions ⇒ `Array<Types::AccessRestriction>`

#address ⇒ `Types::Address`

#business_chains ⇒ `Array<Types::BusinessChain>`

#categories ⇒ `Array<Types::Category>`

#distance ⇒ `Integer`

#food_types ⇒ `Array<Types::FoodType>`

#map_view ⇒ `Array<Float>`

#phonemes ⇒ `Types::PhonemeDetails`

#place_id ⇒ `String`

#place_type ⇒ `String`

#political_view ⇒ `String`

#position ⇒ `Array<Float>`

#time_zone ⇒ `Types::TimeZone`