software.amazon.awssdk.services.location.model

Class Place

java.lang.Object

software.amazon.awssdk.services.location.model.Place

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Place.Builder,Place>

@Generated(value="software.amazon.awssdk:codegen")
public final class Place
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Place.Builder,Place>

Contains details about addresses or points of interest that match the search criteria.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Place.Builder

Method Summary

Modifier and Type	Method and Description
String	addressNumber() The numerical portion of an address, such as a building number.
static Place.Builder	builder()
String	country() A country/region specified using ISO 3166 3-digit country/region code.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PlaceGeometry	geometry() Returns the value of the Geometry property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	label() The full name and address of the point of interest such as a city, region, or country.
String	municipality() A name for a local area, such as a city or town name.
String	neighborhood() The name of a community district.
String	postalCode() A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
String	region() A name for an area or geographical division, such as a province or state name.
List<SdkField<?>>	sdkFields()
static Class<? extends Place.Builder>	serializableBuilderClass()
String	street() The name for a street or a road to identify a location.
String	subRegion() A country, or an area that's part of a larger region .
Place.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

addressNumber

public final String addressNumber()

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

Returns:

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

country

public final String country()

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

Returns:

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

geometry

public final PlaceGeometry geometry()

Returns the value of the Geometry property for this object.

Returns:

The value of the Geometry property for this object.

label

public final String label()

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.

Returns:

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

public final String municipality()

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

Returns:

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

neighborhood

public final String neighborhood()

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

Returns:

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

postalCode

public final String postalCode()

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

Returns:

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

region

public final String region()

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

Returns:

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

street

public final String street()

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

Returns:

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

subRegion

public final String subRegion()

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

Returns:

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

toBuilder

public Place.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Place.Builder,Place>

builder

public static Place.Builder builder()

serializableBuilderClass

public static Class<? extends Place.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo