Class FlushRequest

Request for Flush

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<FlushRequestParameters>
PlainRequestBase<FlushRequestParameters>
FlushRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class FlushRequest : PlainRequestBase<FlushRequestParameters>, IFlushRequest, IRequest<FlushRequestParameters>, IRequest

Constructors

| Edit this page View Source

FlushRequest()

/_flush

Declaration
public FlushRequest()
| Edit this page View Source

FlushRequest(Indices)

/{index}/_flush

Declaration
public FlushRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

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

ExpandWildcards

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

Force

If true, the request forces a flush even if there are no changes to commit to the index.

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

IgnoreUnavailable

If false, the request returns an error if it targets a missing or closed index.

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

Self

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

WaitIfOngoing

If true, the flush operation blocks until execution when another flush operation is running. If false, OpenSearch returns an error if you request a flush when another flush operation is running.

Declaration
public bool? WaitIfOngoing { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods