Class ScrollRequest

Request for Scroll

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

Inheritance
object
RequestBase<ScrollRequestParameters>
PlainRequestBase<ScrollRequestParameters>
ScrollRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ScrollRequest : PlainRequestBase<ScrollRequestParameters>, IScrollRequest, ITypedSearchRequest, IRequest<ScrollRequestParameters>, IRequest

Constructors

| Edit this page View Source

ScrollRequest(string, Time)

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

Properties

| Edit this page View Source

Scroll

Declaration
public Time Scroll { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

ScrollId

Declaration
public string ScrollId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Self

Declaration
protected IScrollRequest Self { get; }
Property Value
Type Description
IScrollRequest
| Edit this page View Source

TotalHitsAsInteger

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 bool? TotalHitsAsInteger { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods