SearchPlaceIndexForTextRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.location.model.SearchPlaceIndexForTextRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchPlaceIndexForTextRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SearchPlaceIndexForTextRequest()

Constructors
Constructor and Description
`SearchPlaceIndexForTextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchPlaceIndexForTextRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<Double>`	`getBiasPosition()` An optional parameter that indicates a preference for places that are closer to a specified position.
`List<Double>`	`getFilterBBox()` An optional parameter that limits the search results by returning only places that are within the provided bounding box.
`List<String>`	`getFilterCountries()` An optional parameter that limits the search results by returning only places that are in a specified list of countries.
`String`	`getIndexName()` The name of the place index resource you want to use for the search.
`String`	`getLanguage()` The preferred language used to return results.
`Integer`	`getMaxResults()` An optional parameter.
`String`	`getText()` The address, name, city, or region to be used in the search in free-form text format.
`int`	`hashCode()`
`void`	`setBiasPosition(Collection<Double> biasPosition)` An optional parameter that indicates a preference for places that are closer to a specified position.
`void`	`setFilterBBox(Collection<Double> filterBBox)` An optional parameter that limits the search results by returning only places that are within the provided bounding box.
`void`	`setFilterCountries(Collection<String> filterCountries)` An optional parameter that limits the search results by returning only places that are in a specified list of countries.
`void`	`setIndexName(String indexName)` The name of the place index resource you want to use for the search.
`void`	`setLanguage(String language)` The preferred language used to return results.
`void`	`setMaxResults(Integer maxResults)` An optional parameter.
`void`	`setText(String text)` The address, name, city, or region to be used in the search in free-form text format.
`String`	`toString()` Returns a string representation of this object.
`SearchPlaceIndexForTextRequest`	`withBiasPosition(Collection<Double> biasPosition)` An optional parameter that indicates a preference for places that are closer to a specified position.
`SearchPlaceIndexForTextRequest`	`withBiasPosition(Double... biasPosition)` An optional parameter that indicates a preference for places that are closer to a specified position.
`SearchPlaceIndexForTextRequest`	`withFilterBBox(Collection<Double> filterBBox)` An optional parameter that limits the search results by returning only places that are within the provided bounding box.
`SearchPlaceIndexForTextRequest`	`withFilterBBox(Double... filterBBox)` An optional parameter that limits the search results by returning only places that are within the provided bounding box.
`SearchPlaceIndexForTextRequest`	`withFilterCountries(Collection<String> filterCountries)` An optional parameter that limits the search results by returning only places that are in a specified list of countries.
`SearchPlaceIndexForTextRequest`	`withFilterCountries(String... filterCountries)` An optional parameter that limits the search results by returning only places that are in a specified list of countries.
`SearchPlaceIndexForTextRequest`	`withIndexName(String indexName)` The name of the place index resource you want to use for the search.
`SearchPlaceIndexForTextRequest`	`withLanguage(String language)` The preferred language used to return results.
`SearchPlaceIndexForTextRequest`	`withMaxResults(Integer maxResults)` An optional parameter.
`SearchPlaceIndexForTextRequest`	`withText(String text)` The address, name, city, or region to be used in the search in free-form text format.

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

- Constructor Detail
  - SearchPlaceIndexForTextRequest
```
public SearchPlaceIndexForTextRequest()
```
- Method Detail
  - getBiasPosition
```
public List<Double> getBiasPosition()
```
    An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
  - setBiasPosition
```
public void setBiasPosition(Collection<Double> biasPosition)
```
    An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    Parameters:
    
    biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
  - withBiasPosition
```
public SearchPlaceIndexForTextRequest withBiasPosition(Double... biasPosition)
```
    An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    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 - An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBiasPosition
```
public SearchPlaceIndexForTextRequest withBiasPosition(Collection<Double> biasPosition)
```
    An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    Parameters:
    
    biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.
    
    If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
    
    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
    
    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterBBox
```
public List<Double> getFilterBBox()
```
    An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
  - setFilterBBox
```
public void setFilterBBox(Collection<Double> filterBBox)
```
    An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    Parameters:
    
    filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
  - withFilterBBox
```
public SearchPlaceIndexForTextRequest withFilterBBox(Double... filterBBox)
```
    An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    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 - An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterBBox
```
public SearchPlaceIndexForTextRequest withFilterBBox(Collection<Double> filterBBox)
```
    An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    Parameters:
    
    filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.
    
    If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
    
    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.
    
    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterCountries
```
public List<String> getFilterCountries()
```
    An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    - Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    Returns:
    An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    
    Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
  - setFilterCountries
```
public void setFilterCountries(Collection<String> filterCountries)
```
    An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    - Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    Parameters:
    filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    
    Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
  - withFilterCountries
```
public SearchPlaceIndexForTextRequest withFilterCountries(String... filterCountries)
```
    An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    - Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    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 - An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    
    Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterCountries
```
public SearchPlaceIndexForTextRequest withFilterCountries(Collection<String> filterCountries)
```
    An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    - Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    Parameters:
    filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.
    
    Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the place index resource you want to use for the search.
    
    Parameters:
    
    indexName - The name of the place index resource you want to use for the search.
  - getIndexName
```
public String getIndexName()
```
    The name of the place index resource you want to use for the search.
    
    Returns:
    
    The name of the place index resource you want to use for the search.
  - withIndexName
```
public SearchPlaceIndexForTextRequest withIndexName(String indexName)
```
    The name of the place index resource you want to use for the search.
    
    Parameters:
    
    indexName - The name of the place index resource you want to use for the search.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguage
```
public void setLanguage(String language)
```
    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
    
    Parameters:
    
    language - The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
  - getLanguage
```
public String getLanguage()
```
    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
    
    Returns:
    
    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
  - withLanguage
```
public SearchPlaceIndexForTextRequest withLanguage(String language)
```
    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
    
    Parameters:
    
    language - The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
    
    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
    
    For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.
    
    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.
    
    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    An optional parameter. The maximum number of results returned per request.
    
    The default: 50
    
    Parameters:
    
    maxResults - An optional parameter. The maximum number of results returned per request.
    
    The default: 50
  - getMaxResults
```
public Integer getMaxResults()
```
    An optional parameter. The maximum number of results returned per request.
    
    The default: 50
    
    Returns:
    
    An optional parameter. The maximum number of results returned per request.
    
    The default: 50
  - withMaxResults
```
public SearchPlaceIndexForTextRequest withMaxResults(Integer maxResults)
```
    An optional parameter. The maximum number of results returned per request.
    
    The default: 50
    
    Parameters:
    
    maxResults - An optional parameter. The maximum number of results returned per request.
    
    The default: 50
    
    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 search in free-form text format. For example, 123 Any Street.
    
    Parameters:
    
    text - The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
  - getText
```
public String getText()
```
    The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
    
    Returns:
    
    The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
  - withText
```
public SearchPlaceIndexForTextRequest withText(String text)
```
    The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
    
    Parameters:
    
    text - The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.
    
    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 SearchPlaceIndexForTextRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class SearchPlaceIndexForTextRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SearchPlaceIndexForTextRequest

Method Detail

getBiasPosition

setBiasPosition

withBiasPosition

withBiasPosition

getFilterBBox

setFilterBBox

withFilterBBox

withFilterBBox

getFilterCountries

setFilterCountries

withFilterCountries

withFilterCountries

setIndexName

getIndexName

withIndexName

setLanguage

getLanguage

withLanguage

setMaxResults

getMaxResults

withMaxResults

setText

getText

withText

toString

equals

hashCode

clone