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

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

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

The suggested place results.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SuggestPlaceResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AccessPoint>`	`accessPoints()`	Position of the access point represent by longitude and latitude.
`List<AccessRestriction>`	`accessRestrictions()`	Indicates known access restrictions on a vehicle access point.
`Address`	`address()`	The place's address.
`static SuggestPlaceResult.Builder`	`builder()`
`List<BusinessChain>`	`businessChains()`	The Business Chains associated with the place.
`List<Category>`	`categories()`	Categories of results that results must belong to.
`Long`	`distance()`	The distance in meters from the QueryPosition.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FoodType>`	`foodTypes()`	List of food types offered by this result.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccessPoints()`	For responses, this returns true if the service returned a value for the AccessPoints property.
`boolean`	`hasAccessRestrictions()`	For responses, this returns true if the service returned a value for the AccessRestrictions property.
`boolean`	`hasBusinessChains()`	For responses, this returns true if the service returned a value for the BusinessChains property.
`boolean`	`hasCategories()`	For responses, this returns true if the service returned a value for the Categories property.
`boolean`	`hasFoodTypes()`	For responses, this returns true if the service returned a value for the FoodTypes property.
`int`	`hashCode()`
`boolean`	`hasMapView()`	For responses, this returns true if the service returned a value for the MapView property.
`boolean`	`hasPosition()`	For responses, this returns true if the service returned a value for the Position property.
`List<Double>`	`mapView()`	The bounding box enclosing the geometric shape (area or line) that an individual result covers.
`PhonemeDetails`	`phonemes()`	How the various components of the result's address are pronounced in various languages.
`String`	`placeId()`	The `PlaceId` of the place you wish to receive the information for.
`PlaceType`	`placeType()`	A `PlaceType` is a category that the result place must belong to.
`String`	`placeTypeAsString()`	A `PlaceType` is a category that the result place must belong to.
`String`	`politicalView()`	The alpha-2 or alpha-3 character code for the political view of a country.
`List<Double>`	`position()`	The position, in longitude and latitude.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SuggestPlaceResult.Builder>`	`serializableBuilderClass()`
`TimeZone`	`timeZone()`	The time zone in which the place is located.
`SuggestPlaceResult.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
  - placeId
```
public final String placeId()
```
    The PlaceId of the place you wish to receive the information for.
    
    Returns:
    
    The PlaceId of the place you wish to receive the information for.
  - placeType
```
public final PlaceType placeType()
```
    A PlaceType is a category that the result place must belong to.
    
    If the service returns an enum value that is not available in the current SDK version, placeType will return PlaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placeTypeAsString().
    
    Returns:
    
    A PlaceType is a category that the result place must belong to.
    
    See Also:
    
    PlaceType
  - placeTypeAsString
```
public final String placeTypeAsString()
```
    A PlaceType is a category that the result place must belong to.
    
    If the service returns an enum value that is not available in the current SDK version, placeType will return PlaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from placeTypeAsString().
    
    Returns:
    
    A PlaceType is a category that the result place must belong to.
    
    See Also:
    
    PlaceType
  - address
```
public final Address address()
```
    The place's address.
    
    Returns:
    
    The place's address.
  - hasPosition
```
public final boolean hasPosition()
```
    For responses, this returns true if the service returned a value for the Position 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.
  - position
```
public final List<Double> position()
```
    The position, in longitude and latitude.
    
    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 hasPosition() method.
    
    Returns:
    
    The position, in longitude and latitude.
  - distance
```
public final Long distance()
```
    The distance in meters from the QueryPosition.
    
    Returns:
    
    The distance in meters from the QueryPosition.
  - hasMapView
```
public final boolean hasMapView()
```
    For responses, this returns true if the service returned a value for the MapView 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.
  - mapView
```
public final List<Double> mapView()
```
    The bounding box enclosing the geometric shape (area or line) that an individual result covers.
    
    The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
    
    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 hasMapView() method.
    
    Returns:
    
    The bounding box enclosing the geometric shape (area or line) that an individual result covers.
    
    The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
  - hasCategories
```
public final boolean hasCategories()
```
    For responses, this returns true if the service returned a value for the Categories 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.
  - categories
```
public final List<Category> categories()
```
    Categories of results that results must belong to.
    
    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 hasCategories() method.
    
    Returns:
    
    Categories of results that results must belong to.
  - hasFoodTypes
```
public final boolean hasFoodTypes()
```
    For responses, this returns true if the service returned a value for the FoodTypes 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.
  - foodTypes
```
public final List<FoodType> foodTypes()
```
    List of food types offered by this result.
    
    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 hasFoodTypes() method.
    
    Returns:
    
    List of food types offered by this result.
  - hasBusinessChains
```
public final boolean hasBusinessChains()
```
    For responses, this returns true if the service returned a value for the BusinessChains 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.
  - businessChains
```
public final List<BusinessChain> businessChains()
```
    The Business Chains associated with the place.
    
    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 hasBusinessChains() method.
    
    Returns:
    
    The Business Chains associated with the place.
  - hasAccessPoints
```
public final boolean hasAccessPoints()
```
    For responses, this returns true if the service returned a value for the AccessPoints 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.
  - accessPoints
```
public final List<AccessPoint> accessPoints()
```
    Position of the access point represent by longitude and latitude.
    
    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 hasAccessPoints() method.
    
    Returns:
    
    Position of the access point represent by longitude and latitude.
  - hasAccessRestrictions
```
public final boolean hasAccessRestrictions()
```
    For responses, this returns true if the service returned a value for the AccessRestrictions 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.
  - accessRestrictions
```
public final List<AccessRestriction> accessRestrictions()
```
    Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
    
    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 hasAccessRestrictions() method.
    
    Returns:
    
    Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
  - timeZone
```
public final TimeZone timeZone()
```
    The time zone in which the place is located.
    
    Returns:
    
    The time zone in which the place is located.
  - politicalView
```
public final String politicalView()
```
    The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
    
    Returns:
    
    The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
  - phonemes
```
public final PhonemeDetails phonemes()
```
    How the various components of the result's address are pronounced in various languages.
    
    Returns:
    
    How the various components of the result's address are pronounced in various languages.
  - toBuilder
```
public SuggestPlaceResult.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SuggestPlaceResult.Builder,SuggestPlaceResult>
  - builder
```
public static SuggestPlaceResult.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SuggestPlaceResult.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 SuggestPlaceResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

placeId

placeType

placeTypeAsString

address

hasPosition

position

distance

hasMapView

mapView

hasCategories

categories

hasFoodTypes

foodTypes

hasBusinessChains

businessChains

hasAccessPoints

accessPoints

hasAccessRestrictions

accessRestrictions

timeZone

politicalView

phonemes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField