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

AutocompleteAddressHighlights

class AutocompleteAddressHighlights

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

Types

object Companion

Properties

val addressNumber: List<Highlight>?

The house number or address results should have.

val block: List<Highlight>?

Name of the block.

val building: List<Highlight>?

The name of the building at the address.

val country: CountryHighlights?

The alpha-2 or alpha-3 character code for the country that the results will be present in.

val district: List<Highlight>?

The district or division of a city the results should be present in.

val intersection: List<List<Highlight>>?

Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]

val label: List<Highlight>?

Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

val locality: List<Highlight>?

The city or locality results should be present in.

val postalCode: List<Highlight>?

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.

val region: RegionHighlights?

The region or state results should be to be present in.

val street: List<Highlight>?

The name of the street results should be present in.

val subBlock: List<Highlight>?

Name of sub-block.

val subDistrict: List<Highlight>?

Indicates the starting and ending index of the title in the text query that match the found title.

val subRegion: SubRegionHighlights?

The sub-region or county for which results should be present in.

Functions

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

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

open override fun hashCode(): Int

open override fun toString(): String