Place.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<Place.Builder,Place>, SdkBuilder<Place.Builder,Place>, SdkPojo

Enclosing class:

Place
```
public static interface Place.Builder
extends SdkPojo, CopyableBuilder<Place.Builder,Place>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Place.Builder`	`addressNumber(String addressNumber)` The numerical portion of an address, such as a building number.
`Place.Builder`	`country(String country)` A country/region specified using ISO 3166 3-digit country/region code.
`default Place.Builder`	`geometry(Consumer<PlaceGeometry.Builder> geometry)` Sets the value of the Geometry property for this object.
`Place.Builder`	`geometry(PlaceGeometry geometry)` Sets the value of the Geometry property for this object.
`Place.Builder`	`interpolated(Boolean interpolated)` `True` if the result is interpolated from other known places.
`Place.Builder`	`label(String label)` The full name and address of the point of interest such as a city, region, or country.
`Place.Builder`	`municipality(String municipality)` A name for a local area, such as a city or town name.
`Place.Builder`	`neighborhood(String neighborhood)` The name of a community district.
`Place.Builder`	`postalCode(String postalCode)` A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
`Place.Builder`	`region(String region)` A name for an area or geographical division, such as a province or state name.
`Place.Builder`	`street(String street)` The name for a street or a road to identify a location.
`Place.Builder`	`subRegion(String subRegion)` A country, or an area that's part of a larger region.
`default Place.Builder`	`timeZone(Consumer<TimeZone.Builder> timeZone)` The time zone in which the `Place` is located.
`Place.Builder`	`timeZone(TimeZone timeZone)` The time zone in which the `Place` is located.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - addressNumber
```
Place.Builder addressNumber(String addressNumber)
```
    The numerical portion of an address, such as a building number.
    
    Parameters:
    
    addressNumber - The numerical portion of an address, such as a building number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - country
```
Place.Builder country(String country)
```
    A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
    
    Parameters:
    
    country - A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - geometry
```
Place.Builder geometry(PlaceGeometry geometry)
```
    Sets the value of the Geometry property for this object.
    
    Parameters:
    
    geometry - The new value for the Geometry property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - geometry
```
default Place.Builder geometry(Consumer<PlaceGeometry.Builder> geometry)
```
    Sets the value of the Geometry property for this object. This is a convenience method that creates an instance of the PlaceGeometry.Builder avoiding the need to create one manually via PlaceGeometry.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to geometry(PlaceGeometry).
    
    Parameters:
    
    geometry - a consumer that will call methods on PlaceGeometry.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    geometry(PlaceGeometry)
  - interpolated
```
Place.Builder interpolated(Boolean interpolated)
```
    True if the result is interpolated from other known places.
    
    False if the Place is a known place.
    
    Not returned when the partner does not provide the information.
    
    For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
    
    Parameters:
    
    interpolated - True if the result is interpolated from other known places.
    
    False if the Place is a known place.
    
    Not returned when the partner does not provide the information.
    
    For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - label
```
Place.Builder label(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - municipality
```
Place.Builder municipality(String municipality)
```
    A name for a local area, such as a city or town name. For example, Toronto.
    
    Parameters:
    
    municipality - A name for a local area, such as a city or town name. For example, Toronto.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - neighborhood
```
Place.Builder neighborhood(String neighborhood)
```
    The name of a community district. For example, Downtown.
    
    Parameters:
    
    neighborhood - The name of a community district. For example, Downtown.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - postalCode
```
Place.Builder postalCode(String postalCode)
```
    A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
    
    Parameters:
    
    postalCode - A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - region
```
Place.Builder region(String region)
```
    A name for an area or geographical division, such as a province or state name. For example, British Columbia.
    
    Parameters:
    
    region - A name for an area or geographical division, such as a province or state name. For example, British Columbia.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - street
```
Place.Builder street(String street)
```
    The name for a street or a road to identify a location. For example, Main Street.
    
    Parameters:
    
    street - The name for a street or a road to identify a location. For example, Main Street.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - subRegion
```
Place.Builder subRegion(String subRegion)
```
    A country, or an area that's part of a larger region. For example, Metro Vancouver.
    
    Parameters:
    
    subRegion - A country, or an area that's part of a larger region. For example, Metro Vancouver.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeZone
```
Place.Builder timeZone(TimeZone timeZone)
```
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Parameters:
    
    timeZone - The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeZone
```
default Place.Builder timeZone(Consumer<TimeZone.Builder> timeZone)
```
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
    This is a convenience method that creates an instance of the TimeZone.Builder avoiding the need to create one manually via TimeZone.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeZone(TimeZone).
    
    Parameters:
    
    timeZone - a consumer that will call methods on TimeZone.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    timeZone(TimeZone)

Interface Place.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

addressNumber

country

geometry

geometry

interpolated

label

municipality

neighborhood

postalCode

region

street

subRegion

timeZone

timeZone