Interface SearchTextResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<SearchTextResponse.Builder,SearchTextResponse>, GeoPlacesResponse.Builder, SdkBuilder<SearchTextResponse.Builder,SearchTextResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SearchTextResponse

@Mutable
@NotThreadSafe
public static interface SearchTextResponse.Builder
extends GeoPlacesResponse.Builder, SdkPojo, CopyableBuilder<SearchTextResponse.Builder,SearchTextResponse>

Method Summary

Modifier and Type	Method	Description
SearchTextResponse.Builder	nextToken(String nextToken)	If nextToken is returned, there are more results available.
SearchTextResponse.Builder	pricingBucket(String pricingBucket)	The pricing bucket for which the query is charged at.
SearchTextResponse.Builder	resultItems(Collection<SearchTextResultItem> resultItems)	List of places or results returned for a query.
SearchTextResponse.Builder	resultItems(Consumer<SearchTextResultItem.Builder>... resultItems)	List of places or results returned for a query.
SearchTextResponse.Builder	resultItems(SearchTextResultItem... resultItems)	List of places or results returned for a query.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.geoplaces.model.GeoPlacesResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Details

pricingBucket

SearchTextResponse.Builder pricingBucket(String pricingBucket)

The pricing bucket for which the query is charged at.

For more information on pricing, please visit Amazon Location Service Pricing.

Parameters:

pricingBucket - The pricing bucket for which the query is charged at.

For more information on pricing, please visit Amazon Location Service Pricing.

Returns:

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

resultItems

SearchTextResponse.Builder resultItems(Collection<SearchTextResultItem> resultItems)

List of places or results returned for a query.

Parameters:

resultItems - List of places or results returned for a query.

Returns:

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

resultItems

SearchTextResponse.Builder resultItems(SearchTextResultItem... resultItems)

List of places or results returned for a query.

Parameters:

resultItems - List of places or results returned for a query.

Returns:

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

resultItems

SearchTextResponse.Builder resultItems(Consumer<SearchTextResultItem.Builder>... resultItems)

List of places or results returned for a query.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resultItems(List<SearchTextResultItem>).

Parameters:

resultItems - a consumer that will call methods on SearchTextResultItem.Builder

Returns:

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

See Also:

• resultItems(java.util.Collection<SearchTextResultItem>)

nextToken

SearchTextResponse.Builder nextToken(String nextToken)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

Parameters:

nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

Returns:

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