@Generated(value="software.amazon.awssdk:codegen") public final class SearchPlaceIndexForPositionRequest extends LocationRequest implements ToCopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchPlaceIndexForPositionRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static SearchPlaceIndexForPositionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPosition()
For responses, this returns true if the service returned a value for the Position property.
|
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<Double> |
position()
Specifies the longitude and latitude of the position to query.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SearchPlaceIndexForPositionRequest.Builder> |
serializableBuilderClass() |
SearchPlaceIndexForPositionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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, 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 a location around Athens, Greece, with the
language parameter set to en. The city in the results will most likely be
returned as Athens.
If you set the language parameter to el, for Greek, then the city in the
results 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, 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 a location around Athens, Greece, with the
language parameter set to en. The city in the results will most
likely be returned as Athens.
If you set the language parameter to el, for Greek, then the city
in the results 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.
Default value: 50
Default value: 50
public final boolean hasPosition()
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> position()
Specifies the longitude and latitude of the position to query.
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 a position with longitude -123.1174 and
latitude 49.2847.
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 hasPosition() method.
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 a position with longitude
-123.1174 and latitude 49.2847.
public SearchPlaceIndexForPositionRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>toBuilder in class LocationRequestpublic static SearchPlaceIndexForPositionRequest.Builder builder()
public static Class<? extends SearchPlaceIndexForPositionRequest.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.