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

Builder

Properties

var additionalFeatures: List<SearchTextAdditionalFeature>?

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

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.

filter

var filter: SearchTextFilter?

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: SearchTextIntendedUse?

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.

nextToken

var nextToken: String?

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

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.

queryId

var queryId: String?

The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API.

queryText

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

Functions

filter

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

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