Class FlushDescriptor

Descriptor for Flush

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

FlushDescriptor()

/_flush

Declaration
public FlushDescriptor()
| Edit this page View Source

FlushDescriptor(Indices)

/{index}/_flush

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public FlushDescriptor AllIndices()
Returns
Type Description
FlushDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

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 FlushDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
FlushDescriptor
| Edit this page View Source

ExpandWildcards(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 FlushDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
FlushDescriptor
| Edit this page View Source

Force(bool?)

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

Declaration
public FlushDescriptor Force(bool? force = true)
Parameters
Type Name Description
bool? force
Returns
Type Description
FlushDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

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

Declaration
public FlushDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
FlushDescriptor
| Edit this page View Source

Index(Indices)

A comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (). To flush all data streams and indexes, omit this parameter or use or _all.

Declaration
public FlushDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
FlushDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public FlushDescriptor Index<TOther>() where TOther : class
Returns
Type Description
FlushDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

WaitIfOngoing(bool?)

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 FlushDescriptor WaitIfOngoing(bool? waitifongoing = true)
Parameters
Type Name Description
bool? waitifongoing
Returns
Type Description
FlushDescriptor

Implements

Extension Methods