Class RefreshRequest

Request for Refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

Inheritance
object
RequestBase<RefreshRequestParameters>
PlainRequestBase<RefreshRequestParameters>
RefreshRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RefreshRequest : PlainRequestBase<RefreshRequestParameters>, IRefreshRequest, IRequest<RefreshRequestParameters>, IRequest

Constructors

| Edit this page View Source

RefreshRequest()

/_refresh

Declaration
public RefreshRequest()
| Edit this page View Source

RefreshRequest(Indices)

/{index}/_refresh

Declaration
public RefreshRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

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

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

Self

Declaration
protected IRefreshRequest Self { get; }
Property Value
Type Description
IRefreshRequest

Implements

Extension Methods