SearchForSuggestionsResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.location.model.SearchForSuggestionsResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchForSuggestionsResult
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchForSuggestionsResult()

Constructors
Constructor and Description
`SearchForSuggestionsResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchForSuggestionsResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCategories()` The Amazon Location categories that describe the Place.
`String`	`getPlaceId()` The unique identifier of the Place.
`List<String>`	`getSupplementalCategories()` Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
`String`	`getText()` The text of the place suggestion, typically formatted as an address string.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCategories(Collection<String> categories)` The Amazon Location categories that describe the Place.
`void`	`setPlaceId(String placeId)` The unique identifier of the Place.
`void`	`setSupplementalCategories(Collection<String> supplementalCategories)` Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
`void`	`setText(String text)` The text of the place suggestion, typically formatted as an address string.
`String`	`toString()` Returns a string representation of this object.
`SearchForSuggestionsResult`	`withCategories(Collection<String> categories)` The Amazon Location categories that describe the Place.
`SearchForSuggestionsResult`	`withCategories(String... categories)` The Amazon Location categories that describe the Place.
`SearchForSuggestionsResult`	`withPlaceId(String placeId)` The unique identifier of the Place.
`SearchForSuggestionsResult`	`withSupplementalCategories(Collection<String> supplementalCategories)` Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
`SearchForSuggestionsResult`	`withSupplementalCategories(String... supplementalCategories)` Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
`SearchForSuggestionsResult`	`withText(String text)` The text of the place suggestion, typically formatted as an address string.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchForSuggestionsResult
```
public SearchForSuggestionsResult()
```
- Method Detail
  - getCategories
```
public List<String> getCategories()
```
    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.
    
    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.
  - setCategories
```
public void setCategories(Collection<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.
    
    Parameters:
    
    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.
  - withCategories
```
public SearchForSuggestionsResult withCategories(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCategories(java.util.Collection) or withCategories(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCategories
```
public SearchForSuggestionsResult withCategories(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaceId
```
public void setPlaceId(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.
    
    Parameters:
    
    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.
  - getPlaceId
```
public String getPlaceId()
```
    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.
  - withPlaceId
```
public SearchForSuggestionsResult withPlaceId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSupplementalCategories
```
public List<String> getSupplementalCategories()
```
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    Returns:
    
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
  - setSupplementalCategories
```
public void setSupplementalCategories(Collection<String> supplementalCategories)
```
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    Parameters:
    
    supplementalCategories - Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
  - withSupplementalCategories
```
public SearchForSuggestionsResult withSupplementalCategories(String... supplementalCategories)
```
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupplementalCategories(java.util.Collection) or withSupplementalCategories(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    supplementalCategories - Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSupplementalCategories
```
public SearchForSuggestionsResult withSupplementalCategories(Collection<String> supplementalCategories)
```
    Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    Parameters:
    
    supplementalCategories - Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The text of the place suggestion, typically formatted as an address string.
    
    Parameters:
    
    text - The text of the place suggestion, typically formatted as an address string.
  - getText
```
public String getText()
```
    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.
  - withText
```
public SearchForSuggestionsResult withText(String text)
```
    The text of the place suggestion, typically formatted as an address string.
    
    Parameters:
    
    text - The text of the place suggestion, typically formatted as an address string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SearchForSuggestionsResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.555

Class SearchForSuggestionsResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchForSuggestionsResult

Method Detail

getCategories

setCategories

withCategories

withCategories

setPlaceId

getPlaceId

withPlaceId

getSupplementalCategories

setSupplementalCategories

withSupplementalCategories

withSupplementalCategories

setText

getText

withText

toString

equals

hashCode

clone

marshall