software.amazon.awssdk.services.location.model

Interface SearchPlaceIndexForSuggestionsSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SearchPlaceIndexForSuggestionsSummary.Builder,SearchPlaceIndexForSuggestionsSummary>, SdkBuilder<SearchPlaceIndexForSuggestionsSummary.Builder,SearchPlaceIndexForSuggestionsSummary>, SdkPojo

Enclosing class:

SearchPlaceIndexForSuggestionsSummary

public static interface SearchPlaceIndexForSuggestionsSummary.Builder
extends SdkPojo, CopyableBuilder<SearchPlaceIndexForSuggestionsSummary.Builder,SearchPlaceIndexForSuggestionsSummary>

Method Summary

Modifier and Type	Method and Description
SearchPlaceIndexForSuggestionsSummary.Builder	biasPosition(Collection<Double> biasPosition) Contains the coordinates for the optional bias position specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	biasPosition(Double... biasPosition) Contains the coordinates for the optional bias position specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	dataSource(String dataSource) The geospatial data provider attached to the place index resource specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	filterBBox(Collection<Double> filterBBox) Contains the coordinates for the optional bounding box specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	filterBBox(Double... filterBBox) Contains the coordinates for the optional bounding box specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	filterCountries(Collection<String> filterCountries) Contains the optional country filter specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	filterCountries(String... filterCountries) Contains the optional country filter specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	language(String language) The preferred language used to return results.
SearchPlaceIndexForSuggestionsSummary.Builder	maxResults(Integer maxResults) Contains the optional result count limit specified in the request.
SearchPlaceIndexForSuggestionsSummary.Builder	text(String text) The free-form partial text input specified in the request.

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

SearchPlaceIndexForSuggestionsSummary.Builder biasPosition(Collection<Double> biasPosition)

Contains the coordinates for the optional bias position specified in the request.

This parameter contains 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.

Parameters:

biasPosition - Contains the coordinates for the optional bias position specified in the request.

This parameter contains 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.

Returns:

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

biasPosition

SearchPlaceIndexForSuggestionsSummary.Builder biasPosition(Double... biasPosition)

Contains the coordinates for the optional bias position specified in the request.

This parameter contains 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.

Parameters:

biasPosition - Contains the coordinates for the optional bias position specified in the request.

This parameter contains 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.

Returns:

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

dataSource

SearchPlaceIndexForSuggestionsSummary.Builder dataSource(String dataSource)

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

Parameters:

dataSource - The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

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

filterBBox

SearchPlaceIndexForSuggestionsSummary.Builder filterBBox(Collection<Double> filterBBox)

Contains the coordinates for the optional bounding box specified in the request.

Parameters:

filterBBox - Contains the coordinates for the optional bounding box specified in the request.

Returns:

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

filterBBox

SearchPlaceIndexForSuggestionsSummary.Builder filterBBox(Double... filterBBox)

Contains the coordinates for the optional bounding box specified in the request.

Parameters:

filterBBox - Contains the coordinates for the optional bounding box specified in the request.

Returns:

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

filterCountries

SearchPlaceIndexForSuggestionsSummary.Builder filterCountries(Collection<String> filterCountries)

Contains the optional country filter specified in the request.

Parameters:

filterCountries - Contains the optional country filter specified in the request.

Returns:

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

filterCountries

SearchPlaceIndexForSuggestionsSummary.Builder filterCountries(String... filterCountries)

Contains the optional country filter specified in the request.

Parameters:

filterCountries - Contains the optional country filter specified in the request.

Returns:

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

language

SearchPlaceIndexForSuggestionsSummary.Builder language(String language)

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Parameters:

language - The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Returns:

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

maxResults

SearchPlaceIndexForSuggestionsSummary.Builder maxResults(Integer maxResults)

Contains the optional result count limit specified in the request.

Parameters:

maxResults - Contains the optional result count limit specified in the request.

Returns:

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

text

SearchPlaceIndexForSuggestionsSummary.Builder text(String text)

The free-form partial text input specified in the request.

Parameters:

text - The free-form partial text input specified in the request.

Returns:

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