Class: Aws::GeoPlaces::Types::AutocompleteRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:query_text, :bias_position, :key]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_features ⇒ Array<String>

A list of optional additional parameters that can be requested for each result.

Returns:

  • (Array<String>) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#bias_position ⇒ Array<Float>

The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in ‘[lng, lat]` and in the WSG84 format.

<note markdown=“1”> The fields ‘BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are mutually exclusive.

</note>

Returns:

  • (Array<Float>) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#filter ⇒ Types::AutocompleteFilter

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

Returns:



533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#intended_use ⇒ String

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

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_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) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_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) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_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) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#postal_code_mode ⇒ String

The ‘PostalCodeMode` affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it’s populated with the value ‘cityLookup`, all cities in that postal code are returned.

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end

#query_text ⇒ String

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/aws-sdk-geoplaces/types.rb', line 533

class AutocompleteRequest < Struct.new(
  :query_text,
  :max_results,
  :bias_position,
  :filter,
  :postal_code_mode,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key)
  SENSITIVE = [:query_text, :bias_position, :key]
  include Aws::Structure
end