Class: Aws::GeoPlaces::Types::Address

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

Overview

The place address.

See Also:

Constant Summary collapse

SENSITIVE = 
[:label, :locality, :district, :sub_district, :postal_code, :block, :sub_block, :street, :address_number, :building]

Instance Attribute Summary collapse

Instance Attribute Details

#address_number ⇒ String

The number that identifies an address within a street.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#block ⇒ String

Name of the block.

Example: Sunny Mansion 203 block: 2 Chome

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#building ⇒ String

The name of the building at the address.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#country ⇒ Types::Country

The country component of the address.

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#district ⇒ String

The district or division of a locality associated with this address.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#intersection ⇒ Array<String>

Name of the streets in the intersection.

Example: ["Friedrichstraße","Unter den Linden"]

Returns:

  • (Array<String>) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#label ⇒ String

Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#locality ⇒ String

The city or locality of the address.

Example: Vancouver.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#postal_code ⇒ String

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:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#region ⇒ Types::Region

The region or state results should be present in.

Example: North Rhine-Westphalia.

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#secondary_address_components ⇒ Array<Types::SecondaryAddressComponent>

Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.

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

AUS, CAN, NZL, USA, PRI

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#street ⇒ String

The name of the street results should be present in.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#street_components ⇒ Array<Types::StreetComponents>

Components of the street.

Example: Younge from the "Younge street".

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#sub_block ⇒ String

Name of sub-block.

Example: Sunny Mansion 203 sub-block: 4

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#sub_district ⇒ String

A subdivision of a district.

Example: Minden-Lübbecke.

Returns:

  • (String) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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

#sub_region ⇒ Types::SubRegion

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

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 158

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