Interface SearchResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CloudSearchDomainResponse.Builder, CopyableBuilder<SearchResponse.Builder,SearchResponse>, SdkBuilder<SearchResponse.Builder,SearchResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SearchResponse

public static interface SearchResponse.Builder
extends CloudSearchDomainResponse.Builder, SdkPojo, CopyableBuilder<SearchResponse.Builder,SearchResponse>

Method Summary

Modifier and Type	Method	Description
SearchResponse.Builder	facets(Map<String,BucketInfo> facets)	The requested facet information.
default SearchResponse.Builder	hits(Consumer<Hits.Builder> hits)	The documents that match the search criteria.
SearchResponse.Builder	hits(Hits hits)	The documents that match the search criteria.
SearchResponse.Builder	stats(Map<String,FieldStats> stats)	The requested field statistics information.
default SearchResponse.Builder	status(Consumer<SearchStatus.Builder> status)	The status information returned for the search request.
SearchResponse.Builder	status(SearchStatus status)	The status information returned for the search request.

Methods inherited from interface software.amazon.awssdk.services.cloudsearchdomain.model.CloudSearchDomainResponse.Builder

build, responseMetadata, responseMetadata

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Details

status

SearchResponse.Builder status(SearchStatus status)

The status information returned for the search request.

Parameters:

status - The status information returned for the search request.

Returns:

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

status

default SearchResponse.Builder status(Consumer<SearchStatus.Builder> status)

The status information returned for the search request.

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

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

Parameters:

status - a consumer that will call methods on SearchStatus.Builder

Returns:

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

See Also:

• status(SearchStatus)

hits

SearchResponse.Builder hits(Hits hits)

The documents that match the search criteria.

Parameters:

hits - The documents that match the search criteria.

Returns:

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

hits

default SearchResponse.Builder hits(Consumer<Hits.Builder> hits)

The documents that match the search criteria.

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

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

Parameters:

hits - a consumer that will call methods on Hits.Builder

Returns:

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

See Also:

• hits(Hits)

facets

SearchResponse.Builder facets(Map<String,BucketInfo> facets)

The requested facet information.

Parameters:

facets - The requested facet information.

Returns:

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

stats

SearchResponse.Builder stats(Map<String,FieldStats> stats)

The requested field statistics information.

Parameters:

stats - The requested field statistics information.

Returns:

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