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) Searches for results closest to the given position.
SearchPlaceIndexForTextRequest.Builder	biasPosition(Double... biasPosition) Searches for results closest to the given position.
SearchPlaceIndexForTextRequest.Builder	filterBBox(Collection<Double> filterBBox) Filters the results by returning only Places within the provided bounding box.
SearchPlaceIndexForTextRequest.Builder	filterBBox(Double... filterBBox) Filters the results by returning only Places within the provided bounding box.
SearchPlaceIndexForTextRequest.Builder	filterCountries(Collection<String> filterCountries) Limits the search to the given a list of countries/regions.
SearchPlaceIndexForTextRequest.Builder	filterCountries(String... filterCountries) Limits the search to the given a list of countries/regions.
SearchPlaceIndexForTextRequest.Builder	indexName(String indexName) The name of the place index resource you want to use for the search.
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.

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)

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

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

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

For example, bias=xLongitude&bias=yLatitude.

Parameters:

biasPosition - Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

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

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

For example, bias=xLongitude&bias=yLatitude.

Returns:

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

biasPosition

SearchPlaceIndexForTextRequest.Builder biasPosition(Double... biasPosition)

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

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

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

For example, bias=xLongitude&bias=yLatitude.

Parameters:

biasPosition - Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

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

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

For example, bias=xLongitude&bias=yLatitude.

Returns:

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

filterBBox

SearchPlaceIndexForTextRequest.Builder filterBBox(Collection<Double> filterBBox)

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Parameters:

filterBBox - Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

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

filterBBox

SearchPlaceIndexForTextRequest.Builder filterBBox(Double... filterBBox)

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Parameters:

filterBBox - Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

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

filterCountries

SearchPlaceIndexForTextRequest.Builder filterCountries(Collection<String> filterCountries)

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Parameters:

filterCountries - Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. 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)

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

Parameters:

filterCountries - Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. 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.

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