Class RefreshRequestParameters

Request options for Refresh

<p>https://docs.opensearch.org/latest/api-reference/index-apis/refresh/</p>
Inheritance
object
RequestParameters<RefreshRequestParameters>
RefreshRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class RefreshRequestParameters : RequestParameters<RefreshRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

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?
| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides

Implements

Extension Methods