software.amazon.awssdk.services.location.model

Interface SearchPlaceIndexForTextResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<SearchPlaceIndexForTextResponse.Builder,SearchPlaceIndexForTextResponse>, LocationResponse.Builder, SdkBuilder<SearchPlaceIndexForTextResponse.Builder,SearchPlaceIndexForTextResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SearchPlaceIndexForTextResponse

public static interface SearchPlaceIndexForTextResponse.Builder
extends LocationResponse.Builder, SdkPojo, CopyableBuilder<SearchPlaceIndexForTextResponse.Builder,SearchPlaceIndexForTextResponse>

Method Summary

Modifier and Type	Method and Description
SearchPlaceIndexForTextResponse.Builder	results(Collection<SearchForTextResult> results) A list of Places matching the input text.
SearchPlaceIndexForTextResponse.Builder	results(Consumer<SearchForTextResult.Builder>... results) A list of Places matching the input text.
SearchPlaceIndexForTextResponse.Builder	results(SearchForTextResult... results) A list of Places matching the input text.
default SearchPlaceIndexForTextResponse.Builder	summary(Consumer<SearchPlaceIndexForTextSummary.Builder> summary) Contains a summary of the request.
SearchPlaceIndexForTextResponse.Builder	summary(SearchPlaceIndexForTextSummary summary) Contains a summary of the request.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

results

SearchPlaceIndexForTextResponse.Builder results(Collection<SearchForTextResult> results)

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

Parameters:

results - A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

Returns:

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

results

SearchPlaceIndexForTextResponse.Builder results(SearchForTextResult... results)

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

Parameters:

results - A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

Returns:

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

results

SearchPlaceIndexForTextResponse.Builder results(Consumer<SearchForTextResult.Builder>... results)

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

This is a convenience method that creates an instance of the SearchForTextResult.Builder avoiding the need to create one manually via SearchForTextResult.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #results(List).

Parameters:

results - a consumer that will call methods on SearchForTextResult.Builder

Returns:

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

See Also:

#results(java.util.Collection)

summary

SearchPlaceIndexForTextResponse.Builder summary(SearchPlaceIndexForTextSummary summary)

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

Parameters:

summary - Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

Returns:

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

summary

default SearchPlaceIndexForTextResponse.Builder summary(Consumer<SearchPlaceIndexForTextSummary.Builder> summary)

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

This is a convenience method that creates an instance of the SearchPlaceIndexForTextSummary.Builder avoiding the need to create one manually via SearchPlaceIndexForTextSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to summary(SearchPlaceIndexForTextSummary).

Parameters:

summary - a consumer that will call methods on SearchPlaceIndexForTextSummary.Builder

Returns:

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

See Also:

summary(SearchPlaceIndexForTextSummary)