Package com.atlassian.jira.search.response

Class SearchStreamResponse

java.lang.Object

com.atlassian.jira.search.response.SearchStreamResponse

All Implemented Interfaces:

AutoCloseable

@PublicApi
public class SearchStreamResponse
extends Object
implements AutoCloseable

The response of IndexSearcher.searchStream(SearchRequest).

Make sure to close either this object, or the getHits() stream, after you're done. We recommend using a try-with-resource-block.

Since:

10.6

Constructor Summary

Constructors

Constructor	Description
SearchStreamResponse(Stream<SearchHit> hits, AggregationsResponse aggregations)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the getHits() stream, which releases resources held in the underlying search platforms.
AggregationsResponse	getAggregations()
Stream<SearchHit>	getHits()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchStreamResponse

public SearchStreamResponse(Stream<SearchHit> hits,
 @Nullable
 AggregationsResponse aggregations)

Method Details

getHits

public Stream<SearchHit> getHits()

getAggregations

public AggregationsResponse getAggregations()

close

public void close()

Closes the getHits() stream, which releases resources held in the underlying search platforms. You can no longer use the stream after it's closed.

Specified by:

close in interface AutoCloseable