Class DeleteAliasDescriptor

Descriptor for DeleteAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases

Inheritance
object
RequestBase<DeleteAliasRequestParameters>
RequestDescriptorBase<DeleteAliasDescriptor, DeleteAliasRequestParameters, IDeleteAliasRequest>
DeleteAliasDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DeleteAliasDescriptor : RequestDescriptorBase<DeleteAliasDescriptor, DeleteAliasRequestParameters, IDeleteAliasRequest>, IDescriptor, IDeleteAliasRequest, IRequest<DeleteAliasRequestParameters>, IRequest

Constructors

| Edit this page View Source

DeleteAliasDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected DeleteAliasDescriptor()
| Edit this page View Source

DeleteAliasDescriptor(Indices, Names)

/{index}/_alias/{name}

Declaration
public DeleteAliasDescriptor(Indices index, Names name)
Parameters
Type Name Description
Indices index

this parameter is required
Names name

this parameter is required

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public DeleteAliasDescriptor AllIndices()
Returns
Type Description
DeleteAliasDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Index(Indices)

Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public DeleteAliasDescriptor Index<TOther>() where TOther : class
Returns
Type Description
DeleteAliasDescriptor
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 DeleteAliasDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
DeleteAliasDescriptor
| 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 DeleteAliasDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
DeleteAliasDescriptor

Implements

Extension Methods