Class ScrollRequestParameters

Request options for Scroll

<p>https://docs.opensearch.org/latest/api-reference/search-apis/scroll/#endpoints</p>
Inheritance
object
RequestParameters<ScrollRequestParameters>
ScrollRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class ScrollRequestParameters : RequestParameters<ScrollRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| 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