@Generated(value="software.amazon.awssdk:codegen") public final class SearchPlaceIndexForSuggestionsRequest extends LocationRequest implements ToCopyableBuilder<SearchPlaceIndexForSuggestionsRequest.Builder,SearchPlaceIndexForSuggestionsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchPlaceIndexForSuggestionsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Double> |
biasPosition()
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
|
static SearchPlaceIndexForSuggestionsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<Double> |
filterBBox()
An optional parameter that limits the search results by returning only suggestions within a specified bounding
box.
|
List<String> |
filterCategories()
A list of one or more Amazon Location categories to filter the returned places.
|
List<String> |
filterCountries()
An optional parameter that limits the search results by returning only suggestions within the provided list of
countries.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasBiasPosition()
For responses, this returns true if the service returned a value for the BiasPosition property.
|
boolean |
hasFilterBBox()
For responses, this returns true if the service returned a value for the FilterBBox property.
|
boolean |
hasFilterCategories()
For responses, this returns true if the service returned a value for the FilterCategories property.
|
boolean |
hasFilterCountries()
For responses, this returns true if the service returned a value for the FilterCountries property.
|
int |
hashCode() |
String |
indexName()
The name of the place index resource you want to use for the search.
|
String |
key()
The optional API key
to authorize the request.
|
String |
language()
The preferred language used to return results.
|
Integer |
maxResults()
An optional parameter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SearchPlaceIndexForSuggestionsRequest.Builder> |
serializableBuilderClass() |
String |
text()
The free-form partial text to use to generate place suggestions.
|
SearchPlaceIndexForSuggestionsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasBiasPosition()
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.public final List<Double> biasPosition()
An optional parameter that indicates a preference for place suggestions 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.
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 hasBiasPosition() method.
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.
public final boolean hasFilterBBox()
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.public final List<Double> filterBBox()
An optional parameter that limits the search results by returning only suggestions within a specified 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.
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 hasFilterBBox() method.
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.
public final boolean hasFilterCategories()
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.public final List<String> filterCategories()
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
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 hasFilterCategories() method.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public final boolean hasFilterCountries()
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.public final List<String> filterCountries()
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
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.
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 hasFilterCountries() method.
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 String key()
The optional API key to authorize the request.
public final 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. 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, Gr to get suggestions with the
language parameter set to en. The results found will most likely be returned as
Athens, Greece.
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.
en for
English.
This setting affects the languages used in the results. 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, Gr to get suggestions
with the language parameter set to en. The results found will most likely be
returned as Athens, Greece.
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.
public final Integer maxResults()
An optional parameter. The maximum number of results returned per request.
The default: 5
The default: 5
public final String text()
The free-form partial text to use to generate place suggestions. For example, eiffel tow.
eiffel tow.public SearchPlaceIndexForSuggestionsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForSuggestionsRequest.Builder,SearchPlaceIndexForSuggestionsRequest>toBuilder in class LocationRequestpublic static SearchPlaceIndexForSuggestionsRequest.Builder builder()
public static Class<? extends SearchPlaceIndexForSuggestionsRequest.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 © 2023. All rights reserved.