Class: Aws::GeoPlaces::Types::GeocodeResultItem

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

Overview

The Geocoded result.

See Also:

Constant Summary collapse

SENSITIVE = 
[:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :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].

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (Boolean) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (Integer) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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}]

Returns:

  • (Array<Float>) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (String) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (String) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (String) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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 World Geodetic System (WGS 84) format: [longitude, latitude].

Returns:

  • (Array<Float>) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

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

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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.

Returns:

  • (String) 


1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1333

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