Class: Aws::GeoPlaces::Types::SearchNearbyRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:query_position, :key]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_features ⇒ Array<String>

A list of optional additional parameters, such as time zone, that can be requested for each result.

Returns:

  • (Array<String>) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#filter ⇒ Types::SearchNearbyFilter

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

Returns:



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#intended_use ⇒ String

Indicates if the results will be stored. Defaults to ‘SingleUse`, if left empty.

Returns:

  • (String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#key ⇒ String

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

  • (String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#language ⇒ String

A list of [BCP 47] compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

[1]: en.wikipedia.org/wiki/IETF_language_tag

Returns:

  • (String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#max_results ⇒ Integer

An optional limit for the number of results returned in a single call.

Returns:

  • (Integer) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#next_token ⇒ String

If ‘nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page.

Returns:

  • (String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#political_view ⇒ String

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

Returns:

  • (String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#query_position ⇒ Array<Float>

The position, in ‘[lng, lat]` for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

Returns:

  • (Array<Float>) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end

#query_radius ⇒ Integer

The maximum distance in meters from the QueryPosition from which a result will be returned.

Returns:

  • (Integer) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 1900

class SearchNearbyRequest < Struct.new(
  :query_position,
  :query_radius,
  :max_results,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :next_token,
  :key)
  SENSITIVE = [:query_position, :key]
  include Aws::Structure
end