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

SearchForTextResult

class SearchForTextResult

Contains a search result from a text search query that is run on a place index resource.

Types

Builder

class Builder

Companion

object Companion

Properties

distance

val distance: Double?

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

place

val place: Place?

Details about the search result, such as its address and position.

placeId

val placeId: String?

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

relevance

val relevance: Double?

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String