Class FlushRequestParameters

Request options for Flush

https://opensearch.org/docs/latest

Inheritance

object

RequestParameters<FlushRequestParameters>

FlushRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<FlushRequestParameters>.CustomResponseBuilder

RequestParameters<FlushRequestParameters>.QueryString

RequestParameters<FlushRequestParameters>.RequestConfiguration

RequestParameters<FlushRequestParameters>.ContainsQueryString(string)

RequestParameters<FlushRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<FlushRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<FlushRequestParameters>.SetQueryString(string, object)

RequestParameters<FlushRequestParameters>.Q<TOut>(string)

RequestParameters<FlushRequestParameters>.Q(string, object)

RequestParameters<FlushRequestParameters>.SetAcceptHeader(string)

RequestParameters<FlushRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.IndicesApi

Assembly: OpenSearch.Net.dll

Syntax

public class FlushRequestParameters : RequestParameters<FlushRequestParameters>, IRequestParameters

Properties

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?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<FlushRequestParameters>.DefaultHttpMethod

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?

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

RequestParameters<FlushRequestParameters>.SupportsBody

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

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)