SearchPlaceIndexForTextSummary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchPlaceIndexForTextSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A summary of the geocoding request sent using SearchPlaceIndexForText.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchPlaceIndexForTextSummary()

Constructors
Constructor and Description
`SearchPlaceIndexForTextSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchPlaceIndexForTextSummary`	`clone()`
`boolean`	`equals(Object obj)`
`List<Double>`	`getBiasPosition()` Contains the coordinates for the bias position entered in the geocoding request.
`String`	`getDataSource()` The data provider of geospatial data.
`List<Double>`	`getFilterBBox()` Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
`List<String>`	`getFilterCountries()` Contains the country filter entered in the geocoding request.
`Integer`	`getMaxResults()` Contains the maximum number of results indicated for the request.
`List<Double>`	`getResultBBox()` A bounding box that contains the search results within the specified area indicated by `FilterBBox`.
`String`	`getText()` The address, name, city or region to be used in the geocoding request.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBiasPosition(Collection<Double> biasPosition)` Contains the coordinates for the bias position entered in the geocoding request.
`void`	`setDataSource(String dataSource)` The data provider of geospatial data.
`void`	`setFilterBBox(Collection<Double> filterBBox)` Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
`void`	`setFilterCountries(Collection<String> filterCountries)` Contains the country filter entered in the geocoding request.
`void`	`setMaxResults(Integer maxResults)` Contains the maximum number of results indicated for the request.
`void`	`setResultBBox(Collection<Double> resultBBox)` A bounding box that contains the search results within the specified area indicated by `FilterBBox`.
`void`	`setText(String text)` The address, name, city or region to be used in the geocoding request.
`String`	`toString()` Returns a string representation of this object.
`SearchPlaceIndexForTextSummary`	`withBiasPosition(Collection<Double> biasPosition)` Contains the coordinates for the bias position entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withBiasPosition(Double... biasPosition)` Contains the coordinates for the bias position entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withDataSource(String dataSource)` The data provider of geospatial data.
`SearchPlaceIndexForTextSummary`	`withFilterBBox(Collection<Double> filterBBox)` Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withFilterBBox(Double... filterBBox)` Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withFilterCountries(Collection<String> filterCountries)` Contains the country filter entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withFilterCountries(String... filterCountries)` Contains the country filter entered in the geocoding request.
`SearchPlaceIndexForTextSummary`	`withMaxResults(Integer maxResults)` Contains the maximum number of results indicated for the request.
`SearchPlaceIndexForTextSummary`	`withResultBBox(Collection<Double> resultBBox)` A bounding box that contains the search results within the specified area indicated by `FilterBBox`.
`SearchPlaceIndexForTextSummary`	`withResultBBox(Double... resultBBox)` A bounding box that contains the search results within the specified area indicated by `FilterBBox`.
`SearchPlaceIndexForTextSummary`	`withText(String text)` The address, name, city or region to be used in the geocoding request.

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

- Constructor Detail
  - SearchPlaceIndexForTextSummary
```
public SearchPlaceIndexForTextSummary()
```
- Method Detail
  - getBiasPosition
```
public List<Double> getBiasPosition()
```
    Contains the coordinates for the bias position entered in the geocoding request.
    
    Returns:
    
    Contains the coordinates for the bias position entered in the geocoding request.
  - setBiasPosition
```
public void setBiasPosition(Collection<Double> biasPosition)
```
    Contains the coordinates for the bias position entered in the geocoding request.
    
    Parameters:
    
    biasPosition - Contains the coordinates for the bias position entered in the geocoding request.
  - withBiasPosition
```
public SearchPlaceIndexForTextSummary withBiasPosition(Double... biasPosition)
```
    Contains the coordinates for the bias position entered in the geocoding request.
    
    NOTE: This method appends the values to the existing list (if any). Use setBiasPosition(java.util.Collection) or withBiasPosition(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    biasPosition - Contains the coordinates for the bias position entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBiasPosition
```
public SearchPlaceIndexForTextSummary withBiasPosition(Collection<Double> biasPosition)
```
    Contains the coordinates for the bias position entered in the geocoding request.
    
    Parameters:
    
    biasPosition - Contains the coordinates for the bias position entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataSource
```
public void setDataSource(String dataSource)
```
    The data provider of geospatial data. Indicates one of the available providers:
    - Esri
    - HERE
    For additional details on data providers, see the Amazon Location Service data providers page.
    Parameters:
    dataSource - The data provider of geospatial data. Indicates one of the available providers:
    
    Esri
    
    HERE
    
    For additional details on data providers, see the Amazon Location Service data providers page.
  - getDataSource
```
public String getDataSource()
```
    The data provider of geospatial data. Indicates one of the available providers:
    - Esri
    - HERE
    For additional details on data providers, see the Amazon Location Service data providers page.
    Returns:
    The data provider of geospatial data. Indicates one of the available providers:
    
    Esri
    
    HERE
    
    For additional details on data providers, see the Amazon Location Service data providers page.
  - withDataSource
```
public SearchPlaceIndexForTextSummary withDataSource(String dataSource)
```
    The data provider of geospatial data. Indicates one of the available providers:
    - Esri
    - HERE
    For additional details on data providers, see the Amazon Location Service data providers page.
    Parameters:
    dataSource - The data provider of geospatial data. Indicates one of the available providers:
    
    Esri
    
    HERE
    
    For additional details on data providers, see the Amazon Location Service data providers page.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterBBox
```
public List<Double> getFilterBBox()
```
    Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    Returns:
    
    Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
  - setFilterBBox
```
public void setFilterBBox(Collection<Double> filterBBox)
```
    Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    Parameters:
    
    filterBBox - Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
  - withFilterBBox
```
public SearchPlaceIndexForTextSummary withFilterBBox(Double... filterBBox)
```
    Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilterBBox(java.util.Collection) or withFilterBBox(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    filterBBox - Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterBBox
```
public SearchPlaceIndexForTextSummary withFilterBBox(Collection<Double> filterBBox)
```
    Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    Parameters:
    
    filterBBox - Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterCountries
```
public List<String> getFilterCountries()
```
    Contains the country filter entered in the geocoding request.
    
    Returns:
    
    Contains the country filter entered in the geocoding request.
  - setFilterCountries
```
public void setFilterCountries(Collection<String> filterCountries)
```
    Contains the country filter entered in the geocoding request.
    
    Parameters:
    
    filterCountries - Contains the country filter entered in the geocoding request.
  - withFilterCountries
```
public SearchPlaceIndexForTextSummary withFilterCountries(String... filterCountries)
```
    Contains the country filter entered in the geocoding request.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilterCountries(java.util.Collection) or withFilterCountries(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    filterCountries - Contains the country filter entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterCountries
```
public SearchPlaceIndexForTextSummary withFilterCountries(Collection<String> filterCountries)
```
    Contains the country filter entered in the geocoding request.
    
    Parameters:
    
    filterCountries - Contains the country filter entered in the geocoding request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    Contains the maximum number of results indicated for the request.
    
    Parameters:
    
    maxResults - Contains the maximum number of results indicated for the request.
  - getMaxResults
```
public Integer getMaxResults()
```
    Contains the maximum number of results indicated for the request.
    
    Returns:
    
    Contains the maximum number of results indicated for the request.
  - withMaxResults
```
public SearchPlaceIndexForTextSummary withMaxResults(Integer maxResults)
```
    Contains the maximum number of results indicated for the request.
    
    Parameters:
    
    maxResults - Contains the maximum number of results indicated for the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResultBBox
```
public List<Double> getResultBBox()
```
    A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    Returns:
    
    A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
  - setResultBBox
```
public void setResultBBox(Collection<Double> resultBBox)
```
    A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    Parameters:
    
    resultBBox - A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
  - withResultBBox
```
public SearchPlaceIndexForTextSummary withResultBBox(Double... resultBBox)
```
    A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    NOTE: This method appends the values to the existing list (if any). Use setResultBBox(java.util.Collection) or withResultBBox(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resultBBox - A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResultBBox
```
public SearchPlaceIndexForTextSummary withResultBBox(Collection<Double> resultBBox)
```
    A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    Parameters:
    
    resultBBox - A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
    
    Parameters:
    
    text - The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
  - getText
```
public String getText()
```
    The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
    
    Returns:
    
    The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
  - withText
```
public SearchPlaceIndexForTextSummary withText(String text)
```
    The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
    
    Parameters:
    
    text - The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
    
    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 SearchPlaceIndexForTextSummary 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.

Did this page help you?

Class SearchPlaceIndexForTextSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchPlaceIndexForTextSummary

Method Detail

getBiasPosition

setBiasPosition

withBiasPosition

withBiasPosition

setDataSource

getDataSource

withDataSource

getFilterBBox

setFilterBBox

withFilterBBox

withFilterBBox

getFilterCountries

setFilterCountries

withFilterCountries

withFilterCountries

setMaxResults

getMaxResults

withMaxResults

getResultBBox

setResultBBox

withResultBBox

withResultBBox

setText

getText

withText

toString

equals

hashCode

clone

marshall