Class: Aws::GeoPlaces::Types::GetPlaceResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]

Instance Attribute Summary collapse

Instance Attribute Details

#access_points ⇒ Array<Types::AccessPoint>

Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#address ⇒ Types::Address

The place's address.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#address_number_corrected ⇒ Boolean

Boolean indicating if the address provided has been corrected. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:

  • (Boolean) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#business_chains ⇒ Array<Types::BusinessChain>

The Business Chains associated with the place.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#categories ⇒ Array<Types::Category>

Categories of results that results must belong to.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#contacts ⇒ Types::Contacts

List of potential contact methods for the result/place. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#food_types ⇒ Array<Types::FoodType>

List of food types offered by this result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#main_address ⇒ Types::RelatedPlace

The main address corresponding to a place of type Secondary Address. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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 of four coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

Returns:

  • (Array<Float>) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#opening_hours ⇒ Array<Types::OpeningHours>

List of opening hours objects. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:

  • (String) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :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>) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#postal_code_details ⇒ Array<Types::PostalCodeDetails>

Contains details about the postal code of the place/result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#pricing_bucket ⇒ String

The pricing bucket for which the query is charged at.

For more information on pricing, please visit Amazon Location Service Pricing.

Returns:

  • (String) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#secondary_addresses ⇒ Array<Types::RelatedPlace>

All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#time_zone ⇒ Types::TimeZone

The time zone in which the place is located.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end

#title ⇒ String

The localized display name of this result item based on request parameter language.

Returns:

  • (String) 


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1655

class GetPlaceResponse < Struct.new(
  :place_id,
  :place_type,
  :title,
  :pricing_bucket,
  :address,
  :address_number_corrected,
  :postal_code_details,
  :position,
  :map_view,
  :categories,
  :food_types,
  :business_chains,
  :contacts,
  :opening_hours,
  :access_points,
  :access_restrictions,
  :time_zone,
  :political_view,
  :phonemes,
  :main_address,
  :secondary_addresses)
  SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
  include Aws::Structure
end