Class: Aws::GeoPlaces::Types::GeocodeQueryComponents

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

Overview

A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

See Also:

Constant Summary collapse

SENSITIVE = 
[:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]

Instance Attribute Summary collapse

Instance Attribute Details

#address_number ⇒ String

The house number or address results should have.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#country ⇒ String

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

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#district ⇒ String

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

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#locality ⇒ String

The city or locality results should be present in.

Example: Vancouver.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  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) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#region ⇒ String

The region or state results should be to be present in.

Example: North Rhine-Westphalia.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#street ⇒ String

The name of the street results should be present in.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end

#sub_region ⇒ String

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

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1082

class GeocodeQueryComponents < Struct.new(
  :country,
  :region,
  :sub_region,
  :locality,
  :district,
  :street,
  :address_number,
  :postal_code)
  SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
  include Aws::Structure
end