java.lang.Object
- software.amazon.awssdk.services.geoplaces.model.Address

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Address.Builder,Address>

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

The place address.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Address.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addressNumber()`	The number that identifies an address within a street.
`String`	`block()`	Name of the block.
`static Address.Builder`	`builder()`
`String`	`building()`	The name of the building at the address.
`Country`	`country()`	The country component of the address.
`String`	`district()`	The district or division of a locality associated with this address.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIntersection()`	For responses, this returns true if the service returned a value for the Intersection property.
`boolean`	`hasStreetComponents()`	For responses, this returns true if the service returned a value for the StreetComponents property.
`List<String>`	`intersection()`	Name of the streets in the intersection.
`String`	`label()`	Assembled address value built out of the address components, according to the regional postal rules.
`String`	`locality()`	The locality or city of the address.
`String`	`postalCode()`	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 posses.
`Region`	`region()`	The region or state results should be present in.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Address.Builder>`	`serializableBuilderClass()`
`String`	`street()`	The name of the street results should be present in.
`List<StreetComponents>`	`streetComponents()`	Components of the street.
`String`	`subBlock()`	Name of sub-block.
`String`	`subDistrict()`	A subdivision of a district.
`SubRegion`	`subRegion()`	The sub-region or county for which results should be present in.
`Address.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
  - label
```
public final String label()
```
    Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
    
    Returns:
    
    Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
  - country
```
public final Country country()
```
    The country component of the address.
    
    Returns:
    
    The country component of the address.
  - region
```
public final Region region()
```
    The region or state results should be present in.
    
    Example: North Rhine-Westphalia.
    
    Returns:
    
    The region or state results should be present in.
    
    Example: North Rhine-Westphalia.
  - subRegion
```
public final SubRegion subRegion()
```
    The sub-region or county for which results should be present in.
    
    Returns:
    
    The sub-region or county for which results should be present in.
  - locality
```
public final String locality()
```
    The locality or city of the address.
    
    Example: Vancouver.
    
    Returns:
    
    The locality or city of the address.
    
    Example: Vancouver.
  - district
```
public final String district()
```
    The district or division of a locality associated with this address.
    
    Returns:
    
    The district or division of a locality associated with this address.
  - subDistrict
```
public final String subDistrict()
```
    A subdivision of a district.
    
    Example: Minden-Lübbecke.
    
    Returns:
    
    A subdivision of a district.
    
    Example: Minden-Lübbecke.
  - postalCode
```
public final String postalCode()
```
    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 posses.
    
    Returns:
    
    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 posses.
  - block
```
public final String block()
```
    Name of the block.
    
    Example: Sunny Mansion 203 block: 2 Chome
    
    Returns:
    
    Name of the block.
    
    Example: Sunny Mansion 203 block: 2 Chome
  - subBlock
```
public final String subBlock()
```
    Name of sub-block.
    
    Example: Sunny Mansion 203 sub-block: 4
    
    Returns:
    
    Name of sub-block.
    
    Example: Sunny Mansion 203 sub-block: 4
  - hasIntersection
```
public final boolean hasIntersection()
```
    For responses, this returns true if the service returned a value for the Intersection property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - intersection
```
public final List<String> intersection()
```
    Name of the streets in the intersection.
    
    Example: ["Friedrichstraße","Unter den Linden"]
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntersection() method.
    
    Returns:
    
    Name of the streets in the intersection.
    
    Example: ["Friedrichstraße","Unter den Linden"]
  - street
```
public final String street()
```
    The name of the street results should be present in.
    
    Returns:
    
    The name of the street results should be present in.
  - hasStreetComponents
```
public final boolean hasStreetComponents()
```
    For responses, this returns true if the service returned a value for the StreetComponents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - streetComponents
```
public final List<StreetComponents> streetComponents()
```
    Components of the street.
    
    Example: Younge from the "Younge street".
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStreetComponents() method.
    
    Returns:
    
    Components of the street.
    
    Example: Younge from the "Younge street".
  - addressNumber
```
public final String addressNumber()
```
    The number that identifies an address within a street.
    
    Returns:
    
    The number that identifies an address within a street.
  - building
```
public final String building()
```
    The name of the building at the address.
    
    Returns:
    
    The name of the building at the address.
  - toBuilder
```
public Address.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Address.Builder,Address>
  - builder
```
public static Address.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Address.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Address

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

label

country

region

subRegion

locality

district

subDistrict

postalCode

block

subBlock

hasIntersection

intersection

street

hasStreetComponents

streetComponents

addressNumber

building

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField