Class FlushDescriptor
Inheritance
FlushDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class FlushDescriptor : RequestDescriptorBase<FlushDescriptor, FlushRequestParameters, IFlushRequest>, IDescriptor, IFlushRequest, IRequest<FlushRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
FlushDescriptor()
Declaration
|
Edit this page
View Source
FlushDescriptor(Indices)
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
|
Edit this page
View Source
AllowNoIndices(bool?)
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 FlushDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public FlushDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
Force(bool?)
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 FlushDescriptor Force(bool? force = true)
Parameters
Type |
Name |
Description |
bool? |
force |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public FlushDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names; use the special string _all
or Indices.All for all indices
Declaration
public FlushDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public FlushDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
WaitIfOngoing(bool?)
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 FlushDescriptor WaitIfOngoing(bool? waitifongoing = true)
Parameters
Type |
Name |
Description |
bool? |
waitifongoing |
|
Returns
Implements
Extension Methods