location/aws.sdk.kotlin.services.location.model/Place/Builder

Builder

class Builder

Properties

addressNumber

var addressNumber: String?

The numerical portion of an address, such as a building number.

categories

var categories: List<String>?

The Amazon Location categories that describe this Place.

country

var country: String?

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

geometry

var geometry: PlaceGeometry?

Places uses a point geometry to specify a location or a Place.

interpolated

var interpolated: Boolean?

True if the result is interpolated from other known places.

label

var label: String?

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

municipality

var municipality: String?

A name for a local area, such as a city or town name. For example, Toronto.

neighborhood

var neighborhood: String?

The name of a community district. For example, Downtown.

postalCode

var postalCode: String?

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

region

var region: String?

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

street

var street: String?

The name for a street or a road to identify a location. For example, Main Street.

subMunicipality

var subMunicipality: String?

An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

subRegion

var subRegion: String?

A county, or an area that's part of a larger region. For example, Metro Vancouver.

supplementalCategories

var supplementalCategories: List<String>?

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

timeZone

var timeZone: TimeZone?

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

unitNumber

var unitNumber: String?

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

unitType

var unitType: String?

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Functions

geometry

fun geometry(block: PlaceGeometry.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.location.model.PlaceGeometry inside the given block

timeZone

fun timeZone(block: TimeZone.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.location.model.TimeZone inside the given block