software.amazon.awssdk.services.location.model

Interface SearchPlaceIndexForPositionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>, LocationRequest.Builder, SdkBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchPlaceIndexForPositionRequest

public static interface SearchPlaceIndexForPositionRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<SearchPlaceIndexForPositionRequest.Builder,SearchPlaceIndexForPositionRequest>

Method Summary

Modifier and Type	Method and Description
SearchPlaceIndexForPositionRequest.Builder	indexName(String indexName) The name of the place index resource you want to use for the search.
SearchPlaceIndexForPositionRequest.Builder	maxResults(Integer maxResults) An optional paramer.
SearchPlaceIndexForPositionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchPlaceIndexForPositionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchPlaceIndexForPositionRequest.Builder	position(Collection<Double> position) Specifies a coordinate for the query defined by a longitude, and latitude.
SearchPlaceIndexForPositionRequest.Builder	position(Double... position) Specifies a coordinate for the query defined by a longitude, and latitude.

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

indexName

SearchPlaceIndexForPositionRequest.Builder indexName(String indexName)

The name of the place index resource you want to use for the search.

Parameters:

indexName - The name of the place index resource you want to use for the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

SearchPlaceIndexForPositionRequest.Builder maxResults(Integer maxResults)

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

Default value: 50

Parameters:

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

Default value: 50

Returns:

Returns a reference to this object so that method calls can be chained together.

position

SearchPlaceIndexForPositionRequest.Builder position(Collection<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 .

Parameters:

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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

position

SearchPlaceIndexForPositionRequest.Builder position(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 .

Parameters:

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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

SearchPlaceIndexForPositionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

SearchPlaceIndexForPositionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder