@Generated(value="software.amazon.awssdk:codegen") public final class SearchPlaceIndexForTextRequest extends LocationRequest implements ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,SearchPlaceIndexForTextRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchPlaceIndexForTextRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Double> |
biasPosition()
Searches for results closest to the given position.
|
static SearchPlaceIndexForTextRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<Double> |
filterBBox()
Filters the results by returning only Places within the provided bounding box.
|
List<String> |
filterCountries()
Limits the search to the given a list of countries/regions.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasBiasPosition()
Returns true if the BiasPosition property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasFilterBBox()
Returns true if the FilterBBox property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasFilterCountries()
Returns true if the FilterCountries property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
String |
indexName()
The name of the place index resource you want to use for the search.
|
Integer |
maxResults()
An optional parameter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SearchPlaceIndexForTextRequest.Builder> |
serializableBuilderClass() |
String |
text()
The address, name, city, or region to be used in the search.
|
SearchPlaceIndexForTextRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasBiasPosition()
public final List<Double> biasPosition()
Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.
The first bias position is the X coordinate, or longitude.
The second bias position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasBiasPosition() to see if a value was sent in this field.
The first bias position is the X coordinate, or longitude.
The second bias position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude.
public final boolean hasFilterBBox()
public final List<Double> filterBBox()
Filters the results by returning only Places within the provided bounding box. An optional parameter.
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
The next bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFilterBBox() to see if a value was sent in this field.
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
The next bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
public final boolean hasFilterCountries()
public final List<String> filterCountries()
Limits the search to the given a list of countries/regions. An optional parameter.
Use the ISO 3166 3-digit country code. For example,
Australia uses three upper-case characters: AUS.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFilterCountries() to see if a value was sent in this field.
Use the ISO 3166 3-digit country code. For
example, Australia uses three upper-case characters: AUS.
public final String indexName()
The name of the place index resource you want to use for the search.
public final Integer maxResults()
An optional parameter. The maximum number of results returned per request.
The default: 50
The default: 50
public final String text()
The address, name, city, or region to be used in the search. In free-form text format. For example,
123 Any Street.
123 Any Street.public SearchPlaceIndexForTextRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,SearchPlaceIndexForTextRequest>toBuilder in class LocationRequestpublic static SearchPlaceIndexForTextRequest.Builder builder()
public static Class<? extends SearchPlaceIndexForTextRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.