software.amazon.awssdk.services.location.model

Class SearchPlaceIndexForPositionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchPlaceIndexForPositionRequest
extends LocationRequest
implements ToCopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchPlaceIndexForPositionRequest.Builder

Method Summary

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	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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

indexName

public final String indexName()

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.

language

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

maxResults

public final Integer maxResults()

An optional parameter. The maximum number of results returned per request.

Default value: 50

Returns:

An optional parameter. The maximum number of results returned per request.

Default value: 50

hasPosition

public final boolean hasPosition()

For responses, this returns true if the service returned a value for the Position property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

position

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.

Returns:

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.

toBuilder

public SearchPlaceIndexForPositionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static SearchPlaceIndexForPositionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchPlaceIndexForPositionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo