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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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.

• #address_names_mode ⇒ String

  Specifies how address names are returned.

• #address_translations ⇒ Array<String>

  Specifies which address components to include translations for.

• #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 query results will be persisted in customer infrastructure.

• #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.

• #postal_code_mode ⇒ String

  The PostalCodeMode affects how postal code results are returned.

• #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 'lib/aws-sdk-geoplaces/types.rb', line 1348

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

#address_names_mode ⇒ String

Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.

Returns:

• (String)

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

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

#address_translations ⇒ Array<String>

Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.

Returns:

• (Array<String>)

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

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 WGS 84 format.

Returns:

• (Array<Float>)

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

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 'lib/aws-sdk-geoplaces/types.rb', line 1348

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

#intended_use ⇒ String

Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

Returns:

• (String)

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

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 'lib/aws-sdk-geoplaces/types.rb', line 1348

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 'lib/aws-sdk-geoplaces/types.rb', line 1348

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

Default value: 20

Returns:

• (Integer)

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

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 'lib/aws-sdk-geoplaces/types.rb', line 1348

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  SENSITIVE = [:query_text, :bias_position, :political_view, :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 EnumerateSpannedLocalities, all cities in that postal code are returned. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names are returned.

Returns:

• (String)

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

class GeocodeRequest < Struct.new(
  :query_text,
  :query_components,
  :max_results,
  :bias_position,
  :filter,
  :additional_features,
  :language,
  :political_view,
  :intended_use,
  :key,
  :postal_code_mode,
  :address_translations,
  :address_names_mode)
  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 'lib/aws-sdk-geoplaces/types.rb', line 1348

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

Returns:

• (String)

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

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