Class: Aws::GeoPlaces::Types::SuggestFilter

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

Overview

SuggestFilter 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, :circle]

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>) 


2462
2463
2464
2465
2466
2467
2468
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 2462

class SuggestFilter < Struct.new(
  :bounding_box,
  :circle,
  :include_countries)
  SENSITIVE = [:bounding_box, :circle]
  include Aws::Structure
end

#circle ⇒ Types::FilterCircle

The Circle that all results must be in.

Returns:



2462
2463
2464
2465
2466
2467
2468
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 2462

class SuggestFilter < Struct.new(
  :bounding_box,
  :circle,
  :include_countries)
  SENSITIVE = [:bounding_box, :circle]
  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>) 


2462
2463
2464
2465
2466
2467
2468
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 2462

class SuggestFilter < Struct.new(
  :bounding_box,
  :circle,
  :include_countries)
  SENSITIVE = [:bounding_box, :circle]
  include Aws::Structure
end