Class FlushRequestParameters
Request options for Flush
https://opensearch.org/docs/latest
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class FlushRequestParameters : RequestParameters<FlushRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceAllowNoIndices
If false
, the request returns an error if any wildcard expression, index alias, or _all
value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceExpandWildcards
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? |
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? |
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? |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceWaitIfOngoing
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? |