Class DeleteAliasDescriptor
Descriptor for DeleteAlias
https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Inheritance
DeleteAliasDescriptor
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 SourceDeleteAliasDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected DeleteAliasDescriptor()
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 SourceAllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public DeleteAliasDescriptor AllIndices()
Returns
Type | Description |
---|---|
DeleteAliasDescriptor |
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public DeleteAliasDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type | Name | Description |
---|---|---|
Time | timeout |
Returns
Type | Description |
---|---|
DeleteAliasDescriptor |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout(Time)
Index(Indices)
A comma-separated list of index names (supports wildcards); use _all
for all indices
Declaration
public DeleteAliasDescriptor Index(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index |
Returns
Type | Description |
---|---|
DeleteAliasDescriptor |
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 |
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public DeleteAliasDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type | Name | Description |
---|---|---|
Time | mastertimeout |
Returns
Type | Description |
---|---|
DeleteAliasDescriptor |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout(Time) instead
Timeout(Time)
Explicit timestamp for the document
Declaration
public DeleteAliasDescriptor Timeout(Time timeout)
Parameters
Type | Name | Description |
---|---|---|
Time | timeout |
Returns
Type | Description |
---|---|
DeleteAliasDescriptor |