geoplaces/aws.sdk.kotlin.services.geoplaces.model/ReverseGeocodeRequest/Builder

Builder

Properties

var additionalFeatures: List<ReverseGeocodeAdditionalFeature>?

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

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

intendedUse

var intendedUse: ReverseGeocodeIntendedUse?

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

key

var 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.

language

var 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.

maxResults

var maxResults: Int?

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

politicalView

var politicalView: 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.

queryPosition

var queryPosition: List<Double>?

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

queryRadius

var queryRadius: Long?

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

Functions

filter

fun filter(block: ReverseGeocodeFilter.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.geoplaces.model.ReverseGeocodeFilter inside the given block