Class IndexExistsDescriptor
Descriptor for Exists
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
Inheritance
IndexExistsDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class IndexExistsDescriptor : RequestDescriptorBase<IndexExistsDescriptor, IndexExistsRequestParameters, IIndexExistsRequest>, IDescriptor, IIndexExistsRequest, IRequest<IndexExistsRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
IndexExistsDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected IndexExistsDescriptor()
|
Edit this page
View Source
IndexExistsDescriptor(Indices)
Declaration
public IndexExistsDescriptor(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
this parameter is required
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public IndexExistsDescriptor AllIndices()
Returns
|
Edit this page
View Source
AllowNoIndices(bool?)
Ignore if a wildcard expression resolves to no concrete indices (default: false)
Declaration
public IndexExistsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether wildcard expressions should get expanded to open or closed indices (default: open)
Declaration
public IndexExistsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
FlatSettings(bool?)
Return settings in flat format (default: false)
Declaration
public IndexExistsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type |
Name |
Description |
bool? |
flatsettings |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Ignore unavailable indexes (default: false)
Declaration
public IndexExistsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
IncludeDefaults(bool?)
Whether to return all default setting for each of the indices.
Declaration
public IndexExistsDescriptor IncludeDefaults(bool? includedefaults = true)
Parameters
Type |
Name |
Description |
bool? |
includedefaults |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names
Declaration
public IndexExistsDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public IndexExistsDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public IndexExistsDescriptor Local(bool? local = true)
Parameters
Type |
Name |
Description |
bool? |
local |
|
Returns
Implements
Extension Methods