Class DeleteIndexDescriptor

Descriptor for Delete

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/

Inheritance
object
RequestBase<DeleteIndexRequestParameters>
RequestDescriptorBase<DeleteIndexDescriptor, DeleteIndexRequestParameters, IDeleteIndexRequest>
DeleteIndexDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
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)

/{index}

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

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public DeleteIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
DeleteIndexDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

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

IgnoreUnavailable(bool?)

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

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

Index(Indices)

Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false.

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public DeleteIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Description
DeleteIndexDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public DeleteIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
DeleteIndexDescriptor
| Edit this page View Source

Timeout(Time)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public DeleteIndexDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
DeleteIndexDescriptor

Implements

Extension Methods