Class: Aws::GeoPlaces::Types::GeocodeRequest

Inherits:

Struct

• Object
• Struct
• Aws::GeoPlaces::Types::GeocodeRequest

Defined in:

gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:query_text, :bias_position, :political_view, :key]

Instance Attribute Summary

• #additional_features ⇒ Array<String>

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

• #bias_position ⇒ Array<Float>

  The position, in longitude and latitude, that the results should be close to.

• #filter ⇒ Types::GeocodeFilter

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

• #intended_use ⇒ String

  Indicates if the results will be stored.

• #key ⇒ String

  Optional: The API key to be used for authorization.

• #language ⇒ String

  A list of [BCP 47][1] compliant language codes for the results to be rendered in.

• #max_results ⇒ Integer

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

• #political_view ⇒ String

  The alpha-2 or alpha-3 character code for the political view of a country.

• #query_components ⇒ Types::GeocodeQueryComponents

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

• #query_text ⇒ String

  The free-form text query to match addresses against.

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

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

#filter ⇒ Types::GeocodeFilter

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

Returns:

• (Types::GeocodeFilter)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

#intended_use ⇒ String

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

Storing the response of an Geocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

Returns:

• (String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

Returns:

• (String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

#query_components ⇒ Types::GeocodeQueryComponents

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

Returns:

• (Types::GeocodeQueryComponents)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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

The fields QueryText, and QueryID are mutually exclusive.

Returns:

• (String)

# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1179

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