Class FlushRequest
Request for Flush
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class FlushRequest : PlainRequestBase<FlushRequestParameters>, IFlushRequest, IRequest<FlushRequestParameters>, IRequest
Constructors
| Edit this page View SourceFlushRequest()
/_flush
Declaration
public FlushRequest()
FlushRequest(Indices)
/{index}/_flush
Declaration
public FlushRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Properties
| Edit this page View SourceAllowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have
been specified)
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ExpandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
Force
Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
Declaration
public bool? Force { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected IFlushRequest Self { get; }
Property Value
Type | Description |
---|---|
IFlushRequest |
WaitIfOngoing
If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.
Declaration
public bool? WaitIfOngoing { get; set; }
Property Value
Type | Description |
---|---|
bool? |