Class: Aws::GeoPlaces::Types::SearchNearbyFilter

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

Overview

SearchNearby structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

See Also:

Constant Summary collapse

SENSITIVE = 
[:bounding_box]

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_box ⇒ 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>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#exclude_business_chains ⇒ Array<String>

The Business Chains associated with the place.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#exclude_categories ⇒ Array<String>

Categories of results that results are excluded from.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#exclude_food_types ⇒ Array<String>

Food types that results are excluded from.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#include_business_chains ⇒ Array<String>

The Business Chains associated with the place.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#include_categories ⇒ Array<String>

Categories of results that results must belong too.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#include_countries ⇒ Array<String>

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end

#include_food_types ⇒ Array<String>

Food types that results are included from.

Returns:

  • (Array<String>) 


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1826

class SearchNearbyFilter < Struct.new(
  :bounding_box,
  :include_countries,
  :include_categories,
  :exclude_categories,
  :include_business_chains,
  :exclude_business_chains,
  :include_food_types,
  :exclude_food_types)
  SENSITIVE = [:bounding_box]
  include Aws::Structure
end