java.lang.Object
- software.amazon.awssdk.services.location.model.SearchForSuggestionsResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>
```
@Generated("software.amazon.awssdk:codegen")
public final class SearchForSuggestionsResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>
```
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchForSuggestionsResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchForSuggestionsResult.Builder`	`builder()`
`List<String>`	`categories()`	The Amazon Location categories that describe the Place.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCategories()`	For responses, this returns true if the service returned a value for the Categories property.
`int`	`hashCode()`
`boolean`	`hasSupplementalCategories()`	For responses, this returns true if the service returned a value for the SupplementalCategories property.
`String`	`placeId()`	The unique identifier of the Place.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchForSuggestionsResult.Builder>`	`serializableBuilderClass()`
`List<String>`	`supplementalCategories()`	Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
`String`	`text()`	The text of the place suggestion, typically formatted as an address string.
`SearchForSuggestionsResult.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
  - 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<String> categories()
```
    The Amazon Location categories that describe the Place.
    
    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
    
    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:
    
    The Amazon Location categories that describe the Place.
    
    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
  - placeId
```
public final String placeId()
```
    The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.
    
    The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.
    
    For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
    
    Returns:
    
    The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.
    
    The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.
    
    For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
  - hasSupplementalCategories
```
public final boolean hasSupplementalCategories()
```
    For responses, this returns true if the service returned a value for the SupplementalCategories 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.
  - supplementalCategories
```
public final List<String> supplementalCategories()
```
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    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 hasSupplementalCategories() method.
    
    Returns:
    
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
  - text
```
public final String text()
```
    The text of the place suggestion, typically formatted as an address string.
    
    Returns:
    
    The text of the place suggestion, typically formatted as an address string.
  - toBuilder
```
public SearchForSuggestionsResult.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchForSuggestionsResult.Builder,SearchForSuggestionsResult>
  - builder
```
public static SearchForSuggestionsResult.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchForSuggestionsResult.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

Class SearchForSuggestionsResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasCategories

categories

placeId

hasSupplementalCategories

supplementalCategories

text

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields