Class RefreshDescriptor
Descriptor for Refresh
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
Inheritance
RefreshDescriptor
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 SourceRefreshDescriptor()
/_refresh
Declaration
public RefreshDescriptor()
RefreshDescriptor(Indices)
/{index}/_refresh
Declaration
public RefreshDescriptor(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Methods
| Edit this page View SourceAllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public RefreshDescriptor AllIndices()
Returns
Type | Description |
---|---|
RefreshDescriptor |
AllowNoIndices(bool?)
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified)
Declaration
public RefreshDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | allownoindices |
Returns
Type | Description |
---|---|
RefreshDescriptor |
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public RefreshDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type | Name | Description |
---|---|---|
ExpandWildcards? | expandwildcards |
Returns
Type | Description |
---|---|
RefreshDescriptor |
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public RefreshDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | ignoreunavailable |
Returns
Type | Description |
---|---|
RefreshDescriptor |
Index(Indices)
A comma-separated list of index names; use the special string _all
or Indices.All to perform the operation on all indices
Declaration
public RefreshDescriptor Index(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index |
Returns
Type | Description |
---|---|
RefreshDescriptor |
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 |