Class ScrollDescriptor<TInferDocument>
Descriptor for Scroll
https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body
Inheritance
ScrollDescriptor<TInferDocument>
Assembly: OpenSearch.Client.dll
public class ScrollDescriptor<TInferDocument> : RequestDescriptorBase<ScrollDescriptor<TInferDocument>, ScrollRequestParameters, IScrollRequest>, IDescriptor, IScrollRequest, IRequest<ScrollRequestParameters>, IRequest, ITypedSearchRequest where TInferDocument : class
Type Parameters
Name |
Description |
TInferDocument |
|
Constructors
|
Edit this page
View Source
Declaration
public ScrollDescriptor(Time scroll, string scrollId)
Parameters
Methods
|
Edit this page
View Source
Specify how long a consistent view of the index should be maintained for scrolled search
Declaration
public ScrollDescriptor<TInferDocument> Scroll(Time scroll)
Parameters
Type |
Name |
Description |
Time |
scroll |
|
Returns
|
Edit this page
View Source
Declaration
public ScrollDescriptor<TInferDocument> ScrollId(string scrollId)
Parameters
Type |
Name |
Description |
string |
scrollId |
|
Returns
|
Edit this page
View Source
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
Declaration
public ScrollDescriptor<TInferDocument> TotalHitsAsInteger(bool? totalhitsasinteger = true)
Parameters
Type |
Name |
Description |
bool? |
totalhitsasinteger |
|
Returns
Implements
Extension Methods