location/aws.sdk.kotlin.services.location.model/SearchPlaceIndexForTextRequest

SearchPlaceIndexForTextRequest

class SearchPlaceIndexForTextRequest

Types

Builder

class Builder

Companion

object Companion

Properties

biasPosition

val biasPosition: List<Double>?

An optional parameter that indicates a preference for places that are closer to a specified position.

filterBBox

val filterBBox: List<Double>?

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

filterCategories

val filterCategories: List<String>?

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

filterCountries

val filterCountries: List<String>?

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

indexName

val indexName: String

The name of the place index resource you want to use for the search.

key

val key: String?

The optional API key to authorize the request.

language

val language: String?

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

maxResults

val maxResults: Int?

An optional parameter. The maximum number of results returned per request.

text

val text: String

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

Functions

copy

inline fun copy(block: SearchPlaceIndexForTextRequest.Builder.() -> Unit = {}): SearchPlaceIndexForTextRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String