Class: Aws::GeoPlaces::Types::GeocodeResultItem
- Inherits:
-
Struct
- Object
- Struct
- Aws::GeoPlaces::Types::GeocodeResultItem
- Defined in:
- gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb
Overview
The Geocoded result.
Constant Summary collapse
- SENSITIVE =
[:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view]
Instance Attribute Summary collapse
-
#access_points ⇒ Array<Types::AccessPoint>
Position of the access point represented by longitude and latitude.
-
#address ⇒ Types::Address
The place's address.
-
#address_number_corrected ⇒ Boolean
Boolean indicating if the address provided has been corrected.
-
#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.
-
#intersections ⇒ Array<Types::Intersection>
All Intersections that are near the provided address.
-
#main_address ⇒ Types::RelatedPlace
The main address corresponding to a place of type Secondary Address.
-
#map_view ⇒ Array<Float>
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
-
#match_scores ⇒ Types::MatchScoreDetails
Indicates how well the entire input matches the returned.
-
#parsed_query ⇒ Types::GeocodeParsedQuery
Free-form text query.
-
#place_id ⇒ String
The
PlaceId
of the place result. -
#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 longitude and latitude.
-
#postal_code_details ⇒ Array<Types::PostalCodeDetails>
Contains details about the postal code of the place/result.
-
#secondary_addresses ⇒ Array<Types::RelatedPlace>
All secondary addresses that are associated with a main address.
-
#time_zone ⇒ Types::TimeZone
The time zone in which the place is located.
-
#title ⇒ String
The localized display name of this result item based on request parameter
language
.
Instance Attribute Details
#access_points ⇒ Array<Types::AccessPoint>
Position of the access point represented by longitude and latitude.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#address ⇒ Types::Address
The place's address.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#address_number_corrected ⇒ Boolean
Boolean indicating if the address provided has been corrected.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#categories ⇒ Array<Types::Category>
Categories of results that results must belong to.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#distance ⇒ Integer
The distance in meters from the QueryPosition.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#food_types ⇒ Array<Types::FoodType>
List of food types offered by this result.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#intersections ⇒ Array<Types::Intersection>
All Intersections that are near the provided address.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#main_address ⇒ Types::RelatedPlace
The main address corresponding to a place of type Secondary Address.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :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}]
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#match_scores ⇒ Types::MatchScoreDetails
Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#parsed_query ⇒ Types::GeocodeParsedQuery
Free-form text query.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#place_id ⇒ String
The PlaceId
of the place result.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :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.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :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.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#position ⇒ Array<Float>
The position in longitude and latitude.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#postal_code_details ⇒ Array<Types::PostalCodeDetails>
Contains details about the postal code of the place/result.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :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.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#time_zone ⇒ Types::TimeZone
The time zone in which the place is located.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |
#title ⇒ String
The localized display name of this result item based on request
parameter language
.
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1309 class GeocodeResultItem < Struct.new( :place_id, :place_type, :title, :address, :address_number_corrected, :postal_code_details, :position, :distance, :map_view, :categories, :food_types, :access_points, :time_zone, :political_view, :match_scores, :parsed_query, :intersections, :main_address, :secondary_addresses) SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view] include Aws::Structure end |