Package org.opensearch.search.pipeline.common.helpers

Class SearchResponseUtil

java.lang.Object

org.opensearch.search.pipeline.common.helpers.SearchResponseUtil

public final class SearchResponseUtil
extends Object

Helper methods for manipulating SearchResponse.

Method Summary

Modifier and Type	Method	Description
static SearchResponse	replaceHits(SearchHit[] newHits, SearchResponse response)	Convenience method when only replacing the SearchHit array within the SearchHits in a SearchResponse.
static SearchResponse	replaceHits(SearchHits newHits, SearchResponse response)	Construct a new SearchResponse based on an existing one, replacing just the SearchHits.

Methods inherited from class java.lang.Object

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

Method Details

replaceHits

public static SearchResponse replaceHits(SearchHits newHits,
 SearchResponse response)

Construct a new SearchResponse based on an existing one, replacing just the SearchHits.

Parameters:

newHits - new SearchHits

response - the existing search response

Returns:

a new search response where the SearchHits has been replaced

replaceHits

public static SearchResponse replaceHits(SearchHit[] newHits,
 SearchResponse response)

Convenience method when only replacing the SearchHit array within the SearchHits in a SearchResponse.

Parameters:

newHits - the new array of SearchHit elements.

response - the search response to update

Returns:

a SearchResponse where the underlying array of SearchHit within the SearchHits has been replaced.