Package org.opensearch.client.opensearch.core

Class SearchResponse.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SearchResult.AbstractBuilder<TDocument,SearchResponse.Builder<TDocument>>

org.opensearch.client.opensearch.core.SearchResponse.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<SearchResponse<TDocument>>

Enclosing class:

SearchResponse<TDocument>

public static class SearchResponse.Builder<TDocument>
extends SearchResult.AbstractBuilder<TDocument,SearchResponse.Builder<TDocument>>
implements ObjectBuilder<SearchResponse<TDocument>>

Builder for SearchResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchResponse<TDocument>	build()	Builds a SearchResponse.
protected SearchResponse.Builder<TDocument>	self()

Methods inherited from class org.opensearch.client.opensearch.core.search.SearchResult.AbstractBuilder

aggregations, aggregations, aggregations, clusters, clusters, documents, documents, fields, fields, hits, hits, maxScore, numReducePhases, phaseTook, phaseTook, pitId, profile, profile, scrollId, shards, shards, suggest, suggest, tDocumentSerializer, terminatedEarly, timedOut, took

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

self

protected SearchResponse.Builder<TDocument> self()

Specified by:

self in class SearchResult.AbstractBuilder<TDocument,SearchResponse.Builder<TDocument>>

build

public SearchResponse<TDocument> build()

Builds a SearchResponse.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.