geoplaces/aws.sdk.kotlin.services.geoplaces.model/GeocodeResultItem

GeocodeResultItem

class GeocodeResultItem

The Geocoded result.

Types

object Companion

Properties

val accessPoints: List<AccessPoint>?

Position of the access point represented by longitude and latitude.

val address: Address?

The place's address.

addressNumberCorrected

val addressNumberCorrected: Boolean?

Boolean indicating if the address provided has been corrected.

val categories: List<Category>?

Categories of results that results must belong to.

val distance: Long

The distance in meters from the QueryPosition.

val foodTypes: List<FoodType>?

List of food types offered by this result.

val intersections: List<Intersection>?

All Intersections that are near the provided address.

val mainAddress: RelatedPlace?

The main address corresponding to a place of type Secondary Address.

val mapView: List<Double>?

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

val matchScores: MatchScoreDetails?

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

val parsedQuery: GeocodeParsedQuery?

Free-form text query.

val placeId: String

The PlaceId of the place result.

val placeType: PlaceType

A PlaceType is a category that the result place must belong to.

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

val position: List<Double>?

The position in longitude and latitude.

postalCodeDetails

val postalCodeDetails: List<PostalCodeDetails>?

Contains details about the postal code of the place/result.

secondaryAddresses

val secondaryAddresses: List<RelatedPlace>?

All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

val timeZone: TimeZone?

The time zone in which the place is located.

val title: String

The localized display name of this result item based on request parameter language.

Functions

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

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

open override fun hashCode(): Int

open override fun toString(): String