Class ScrollAllRequest

Inheritance
object
ScrollAllRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ScrollAllRequest : IScrollAllRequest

Constructors

| Edit this page View Source

ScrollAllRequest(Time, int)

Declaration
public ScrollAllRequest(Time scrollTime, int numberOfSlices)
Parameters
Type Name Description
Time scrollTime
int numberOfSlices
| Edit this page View Source

ScrollAllRequest(Time, int, Field)

Declaration
public ScrollAllRequest(Time scrollTime, int numberOfSlices, Field routingField)
Parameters
Type Name Description
Time scrollTime
int numberOfSlices
Field routingField

Properties

| Edit this page View Source

BackPressure

Simple back pressure implementation that makes sure the minimum max concurrency between producer and consumer is not amplified by the greedier of the two by more then a given back pressure factor When set each scroll request will additionally wait on WaitAsync(CancellationToken) as well as MaxDegreeOfParallelism if set. Not that the consumer has to call Release() on the same instance every time it is done.

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

MaxDegreeOfParallelism

The maximum degree of parallelism we should drain the sliced scroll, defaults to the value of Slices

Declaration
public int? MaxDegreeOfParallelism { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

RoutingField

Set a different routing field, has to have doc_values enabled

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

An optional search request that describes the search we want to scroll over. Defaults to matchall on the index and type of T in the ScrollAllObserver<T>. Note: both scroll and slice information WILL be overriden.

Declaration
public ISearchRequest Search { get; set; }
Property Value
Type Description
ISearchRequest

Implements

Extension Methods