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() Returns true if the Position property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	indexName() The name of the place index resource you want to use for the search.
Integer	maxResults() An optional paramer.
List<Double>	position() Specifies a coordinate for the query defined by a longitude, and latitude.
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.

maxResults

public final Integer maxResults()

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

Default value: 50

Returns:

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

Default value: 50

hasPosition

public final boolean hasPosition()

Returns true if the Position property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

position

public final List<Double> position()

Specifies a coordinate for the query defined by a longitude, and latitude.

• The first position is the X coordinate, or longitude.

• The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPosition() to see if a value was sent in this field.

Returns:

Specifies a coordinate for the query defined by a longitude, and latitude.

• The first position is the X coordinate, or longitude.

• The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

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