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	language(String language) The preferred language used to return results.
SearchPlaceIndexForPositionRequest.Builder	maxResults(Integer maxResults) An optional parameter.
SearchPlaceIndexForPositionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchPlaceIndexForPositionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchPlaceIndexForPositionRequest.Builder	position(Collection<Double> position) Specifies the longitude and latitude of the position to query.
SearchPlaceIndexForPositionRequest.Builder	position(Double... position) Specifies the longitude and latitude of the position to query.

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.

language

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

Parameters:

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:

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

maxResults

SearchPlaceIndexForPositionRequest.Builder maxResults(Integer maxResults)

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

Default value: 50

Parameters:

maxResults - An optional parameter. 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 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.

Parameters:

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.

Returns:

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

position

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

Parameters:

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.

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