Class BulkAliasDescriptor

Descriptor for BulkAlias

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

Inheritance
object
RequestBase<BulkAliasRequestParameters>
RequestDescriptorBase<BulkAliasDescriptor, BulkAliasRequestParameters, IBulkAliasRequest>
BulkAliasDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class BulkAliasDescriptor : RequestDescriptorBase<BulkAliasDescriptor, BulkAliasRequestParameters, IBulkAliasRequest>, IDescriptor, IBulkAliasRequest, IRequest<BulkAliasRequestParameters>, IRequest

Methods

| Edit this page View Source

Add(IAliasAction)

Declaration
public BulkAliasDescriptor Add(IAliasAction action)
Parameters
Type Name Description
IAliasAction action
Returns
Type Description
BulkAliasDescriptor
| Edit this page View Source

Add(Func<AliasAddDescriptor, IAliasAddAction>)

Declaration
public BulkAliasDescriptor Add(Func<AliasAddDescriptor, IAliasAddAction> addSelector)
Parameters
Type Name Description
Func<AliasAddDescriptor, IAliasAddAction> addSelector
Returns
Type Description
BulkAliasDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| 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 BulkAliasDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
BulkAliasDescriptor
| Edit this page View Source

Remove(Func<AliasRemoveDescriptor, IAliasRemoveAction>)

Declaration
public BulkAliasDescriptor Remove(Func<AliasRemoveDescriptor, IAliasRemoveAction> removeSelector)
Parameters
Type Name Description
Func<AliasRemoveDescriptor, IAliasRemoveAction> removeSelector
Returns
Type Description
BulkAliasDescriptor
| Edit this page View Source

RemoveIndex(Func<AliasRemoveIndexDescriptor, IAliasRemoveIndexAction>)

Declaration
public BulkAliasDescriptor RemoveIndex(Func<AliasRemoveIndexDescriptor, IAliasRemoveIndexAction> removeIndexSelector)
Parameters
Type Name Description
Func<AliasRemoveIndexDescriptor, IAliasRemoveIndexAction> removeIndexSelector
Returns
Type Description
BulkAliasDescriptor
| 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 BulkAliasDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
BulkAliasDescriptor

Implements

Extension Methods