Class: Aws::GeoPlaces::Types::GeocodeParsedQueryAddressComponents

Inherits:

Struct

• Object
• Struct
• Aws::GeoPlaces::Types::GeocodeParsedQueryAddressComponents

Includes:

Structure

Defined in:

lib/aws-sdk-geoplaces/types.rb

Overview

Parsed address components in the provided QueryText.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #address_number ⇒ Array<Types::ParsedQueryComponent>

  The number that identifies an address within a street.

• #block ⇒ Array<Types::ParsedQueryComponent>

  Name of the block.

• #building ⇒ Array<Types::ParsedQueryComponent>

  The name of the building at the address.

• #country ⇒ Array<Types::ParsedQueryComponent>

  The alpha-2 or alpha-3 character code for the country that the results will be present in.

• #district ⇒ Array<Types::ParsedQueryComponent>

  The district or division of a city the results should be present in.

• #locality ⇒ Array<Types::ParsedQueryComponent>

  The city or locality of the address.

• #other_components ⇒ Array<Types::ParsedQueryComponent>

  Additional information extracted from the query that does not correspond to standard address components.

• #postal_code ⇒ Array<Types::ParsedQueryComponent>

  An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.

• #region ⇒ Array<Types::ParsedQueryComponent>

  The region or state results should be present in.

• #secondary_address_components ⇒ Array<Types::ParsedQuerySecondaryAddressComponent>

  Parsed secondary address components from the provided query text.

• #street ⇒ Array<Types::ParsedQueryComponent>

  The name of the street results should be present in.

• #sub_block ⇒ Array<Types::ParsedQueryComponent>

  Name of sub-block.

• #sub_district ⇒ Array<Types::ParsedQueryComponent>

  A subdivision of a district.

• #sub_region ⇒ Array<Types::ParsedQueryComponent>

  The sub-region or county for which results should be present in.

Instance Attribute Details

#address_number ⇒ Array<Types::ParsedQueryComponent>

The number that identifies an address within a street.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#block ⇒ Array<Types::ParsedQueryComponent>

Name of the block.

Example: Sunny Mansion 203 block: 2 Chome

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#building ⇒ Array<Types::ParsedQueryComponent>

The name of the building at the address.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#country ⇒ Array<Types::ParsedQueryComponent>

The alpha-2 or alpha-3 character code for the country that the results will be present in.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#district ⇒ Array<Types::ParsedQueryComponent>

The district or division of a city the results should be present in.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#locality ⇒ Array<Types::ParsedQueryComponent>

The city or locality of the address.

Example: Vancouver.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#other_components ⇒ Array<Types::ParsedQueryComponent>

Additional information extracted from the query that does not correspond to standard address components.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#postal_code ⇒ Array<Types::ParsedQueryComponent>

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ Array<Types::ParsedQueryComponent>

The region or state results should be present in.

Example: North Rhine-Westphalia.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_address_components ⇒ Array<Types::ParsedQuerySecondaryAddressComponent>

Parsed secondary address components from the provided query text.

Coverage for ParsedQuery.Address.SecondaryAddressComponents is available in the following countries:

AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA

Returns:

• (Array<Types::ParsedQuerySecondaryAddressComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#street ⇒ Array<Types::ParsedQueryComponent>

The name of the street results should be present in.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#sub_block ⇒ Array<Types::ParsedQueryComponent>

Name of sub-block.

Example: Sunny Mansion 203 sub-block: 4

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#sub_district ⇒ Array<Types::ParsedQueryComponent>

A subdivision of a district.

Example: Minden-Lübbecke.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end

#sub_region ⇒ Array<Types::ParsedQueryComponent>

The sub-region or county for which results should be present in.

Returns:

• (Array<Types::ParsedQueryComponent>)

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

class GeocodeParsedQueryAddressComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :sub_district,
  :postal_code,
  :block,
  :sub_block,
  :street,
  :address_number,
  :building,
  :secondary_address_components,
  :other_components)
  SENSITIVE = []
  include Aws::Structure
end