Class DeleteIndexDescriptor
Descriptor for Delete
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/delete-index/
Inheritance
DeleteIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class DeleteIndexDescriptor : RequestDescriptorBase<DeleteIndexDescriptor, DeleteIndexRequestParameters, IDeleteIndexRequest>, IDescriptor, IDeleteIndexRequest, IRequest<DeleteIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
DeleteIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected DeleteIndexDescriptor()
|
Edit this page
View Source
DeleteIndexDescriptor(Indices)
Declaration
public DeleteIndexDescriptor(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 DeleteIndexDescriptor AllIndices()
Returns
|
Edit this page
View Source
AllowNoIndices(bool?)
Ignore if a wildcard expression resolves to no concrete indices (default: false)
Declaration
public DeleteIndexDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public DeleteIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether wildcard expressions should get expanded to open or closed indices (default: open)
Declaration
public DeleteIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Ignore unavailable indexes (default: false)
Declaration
public DeleteIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of indices to delete; use _all
or *
string to delete all indices
Declaration
public DeleteIndexDescriptor 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 DeleteIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public DeleteIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public DeleteIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
Implements
Extension Methods