Class ScrollRequestParameters

Request options for Scroll

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

Inheritance

object

RequestParameters<ScrollRequestParameters>

ScrollRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ScrollRequestParameters>.CustomResponseBuilder

RequestParameters<ScrollRequestParameters>.QueryString

RequestParameters<ScrollRequestParameters>.RequestConfiguration

RequestParameters<ScrollRequestParameters>.ContainsQueryString(string)

RequestParameters<ScrollRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<ScrollRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ScrollRequestParameters>.SetQueryString(string, object)

RequestParameters<ScrollRequestParameters>.Q<TOut>(string)

RequestParameters<ScrollRequestParameters>.Q(string, object)

RequestParameters<ScrollRequestParameters>.SetAcceptHeader(string)

RequestParameters<ScrollRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class ScrollRequestParameters : RequestParameters<ScrollRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ScrollRequestParameters>.DefaultHttpMethod

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ScrollRequestParameters>.SupportsBody

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

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)