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

SearchPlaceIndexForTextSummary

class SearchPlaceIndexForTextSummary

A summary of the request sent by using SearchPlaceIndexForText.

Types

object Companion

Properties

val biasPosition: List<Double>?

Contains the coordinates for the optional bias position specified in the request.

val dataSource: String

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

val filterBBox: List<Double>?

Contains the coordinates for the optional bounding box specified in the request.

filterCategories

val filterCategories: List<String>?

The optional category filter specified in the request.

filterCountries

val filterCountries: List<String>?

Contains the optional country filter specified in the request.

val language: String?

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

val maxResults: Int?

Contains the optional result count limit specified in the request.

val resultBBox: List<Double>?

The bounding box that fully contains all search results.

val text: String

The search text specified in the request.

Functions

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

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

open override fun hashCode(): Int

open override fun toString(): String