software.amazon.awssdk.services.location.model

Interface SearchPlaceIndexForTextRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchPlaceIndexForTextRequest

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

Method Summary

Modifier and Type	Method and Description
SearchPlaceIndexForTextRequest.Builder	biasPosition(Collection<Double> biasPosition) An optional parameter that indicates a preference for places that are closer to a specified position.
SearchPlaceIndexForTextRequest.Builder	biasPosition(Double... biasPosition) An optional parameter that indicates a preference for places that are closer to a specified position.
SearchPlaceIndexForTextRequest.Builder	filterBBox(Collection<Double> filterBBox) An optional parameter that limits the search results by returning only places that are within the provided bounding box.
SearchPlaceIndexForTextRequest.Builder	filterBBox(Double... filterBBox) An optional parameter that limits the search results by returning only places that are within the provided bounding box.
SearchPlaceIndexForTextRequest.Builder	filterCountries(Collection<String> filterCountries) An optional parameter that limits the search results by returning only places that are in a specified list of countries.
SearchPlaceIndexForTextRequest.Builder	filterCountries(String... filterCountries) An optional parameter that limits the search results by returning only places that are in a specified list of countries.
SearchPlaceIndexForTextRequest.Builder	indexName(String indexName) The name of the place index resource you want to use for the search.
SearchPlaceIndexForTextRequest.Builder	language(String language) The preferred language used to return results.
SearchPlaceIndexForTextRequest.Builder	maxResults(Integer maxResults) An optional parameter.
SearchPlaceIndexForTextRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchPlaceIndexForTextRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchPlaceIndexForTextRequest.Builder	text(String text) The address, name, city, or region to be used in the search in free-form text format.

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

biasPosition

SearchPlaceIndexForTextRequest.Builder biasPosition(Collection<Double> biasPosition)

An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, 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 the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

Parameters:

biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, 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 the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

Returns:

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

biasPosition

SearchPlaceIndexForTextRequest.Builder biasPosition(Double... biasPosition)

An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, 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 the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

Parameters:

biasPosition - An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, 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 the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

Returns:

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

filterBBox

SearchPlaceIndexForTextRequest.Builder filterBBox(Collection<Double> filterBBox)

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

Parameters:

filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

Returns:

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

filterBBox

SearchPlaceIndexForTextRequest.Builder filterBBox(Double... filterBBox)

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

Parameters:

filterBBox - An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

Returns:

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

filterCountries

SearchPlaceIndexForTextRequest.Builder filterCountries(Collection<String> filterCountries)

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

Parameters:

filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

Returns:

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

filterCountries

SearchPlaceIndexForTextRequest.Builder filterCountries(String... filterCountries)

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

Parameters:

filterCountries - An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

Returns:

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

indexName

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

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

SearchPlaceIndexForTextRequest.Builder maxResults(Integer maxResults)

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

The default: 50

Parameters:

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

The default: 50

Returns:

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

text

SearchPlaceIndexForTextRequest.Builder text(String text)

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

Parameters:

text - The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

Returns:

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

overrideConfiguration

SearchPlaceIndexForTextRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder