Package com.atlassian.jira.search.response

Class SearchResponse

java.lang.Object

com.atlassian.jira.search.response.SearchResponse

@PublicApi
public class SearchResponse
extends Object

Represents a search response.

Since:

10.4

Constructor Summary

Constructors

Constructor	Description
SearchResponse(long totalHits, List<SearchHit> hits, PageRequest pageRequest)
SearchResponse(long totalHits, List<SearchHit> hits, PageRequest pageRequest, AggregationsResponse aggregations)
SearchResponse(long totalHits, List<SearchHit> hits, PageRequest pageRequest, AggregationsResponse aggregations, Integer maxResultWindow)

Method Summary

Modifier and Type	Method	Description
AggregationsResponse	getAggregations()
List<SearchHit>	getHits()
Integer	getMaxResultWindow()
Optional<PageRequest>	getNextPageRequest()
PageRequest	getPageRequest()
long	getTotalHits()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResponse

public SearchResponse(long totalHits,
 List<SearchHit> hits,
 PageRequest pageRequest)

SearchResponse

public SearchResponse(long totalHits,
 List<SearchHit> hits,
 PageRequest pageRequest,
 @Nullable
 AggregationsResponse aggregations)

SearchResponse

public SearchResponse(long totalHits,
 List<SearchHit> hits,
 PageRequest pageRequest,
 @Nullable
 AggregationsResponse aggregations,
 @Nullable
 Integer maxResultWindow)

Method Details

getHits

public List<SearchHit> getHits()

getNextPageRequest

public Optional<PageRequest> getNextPageRequest()

getPageRequest

public PageRequest getPageRequest()

getTotalHits

public long getTotalHits()

getAggregations

public AggregationsResponse getAggregations()

Since:

10.5

getMaxResultWindow

@Nullable
public Integer getMaxResultWindow()

Returns:

the maximum number of results that can be retrieved from the underlying search engine, or null if unlimited