Class RefreshDescriptor

Descriptor 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>
RequestDescriptorBase<RefreshDescriptor, RefreshRequestParameters, IRefreshRequest>
RefreshDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RefreshDescriptor : RequestDescriptorBase<RefreshDescriptor, RefreshRequestParameters, IRefreshRequest>, IDescriptor, IRefreshRequest, IRequest<RefreshRequestParameters>, IRequest

Constructors

| Edit this page View Source

RefreshDescriptor()

/_refresh

Declaration
public RefreshDescriptor()
| Edit this page View Source

RefreshDescriptor(Indices)

/{index}/_refresh

Declaration
public RefreshDescriptor(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 RefreshDescriptor AllIndices()
Returns
Type Description
RefreshDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

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 RefreshDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
RefreshDescriptor
| Edit this page View Source

ExpandWildcards(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 RefreshDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
RefreshDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

If false, the request returns an error if it targets a missing or closed index.

Declaration
public RefreshDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
RefreshDescriptor
| Edit this page View Source

Index(Indices)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public RefreshDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
RefreshDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public RefreshDescriptor Index<TOther>() where TOther : class
Returns
Type Description
RefreshDescriptor
Type Parameters
Name Description
TOther

Implements

Extension Methods