Class ScrollDescriptor<TInferDocument>

Descriptor for Scroll

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Inheritance
object
RequestBase<ScrollRequestParameters>
RequestDescriptorBase<ScrollDescriptor<TInferDocument>, ScrollRequestParameters, IScrollRequest>
ScrollDescriptor<TInferDocument>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ScrollDescriptor<TInferDocument> : RequestDescriptorBase<ScrollDescriptor<TInferDocument>, ScrollRequestParameters, IScrollRequest>, IDescriptor, IScrollRequest, ITypedSearchRequest, IRequest<ScrollRequestParameters>, IRequest where TInferDocument : class
Type Parameters
Name Description
TInferDocument

Constructors

| Edit this page View Source

ScrollDescriptor(Time, string)

Declaration
public ScrollDescriptor(Time scroll, string scrollId)
Parameters
Type Name Description
Time scroll
string scrollId

Methods

| Edit this page View Source

Scroll(Time)

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
Type Description
ScrollDescriptor<TInferDocument>
| Edit this page View Source

ScrollId(string)

Declaration
public ScrollDescriptor<TInferDocument> ScrollId(string scrollId)
Parameters
Type Name Description
string scrollId
Returns
Type Description
ScrollDescriptor<TInferDocument>
| Edit this page View Source

TotalHitsAsInteger(bool?)

If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object.

Declaration
public ScrollDescriptor<TInferDocument> TotalHitsAsInteger(bool? totalhitsasinteger = true)
Parameters
Type Name Description
bool? totalhitsasinteger
Returns
Type Description
ScrollDescriptor<TInferDocument>

Implements

Extension Methods