Class SplitIndexDescriptor
Descriptor for Split
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/split/
Inheritance
SplitIndexDescriptor
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SplitIndexDescriptor : RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>, IDescriptor, ISplitIndexRequest, IRequest<SplitIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceSplitIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected SplitIndexDescriptor()
SplitIndexDescriptor(IndexName, IndexName)
/{index}/_split/{target}
Declaration
public SplitIndexDescriptor(IndexName index, IndexName target)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
IndexName | target | this parameter is required |
Methods
| Edit this page View SourceAliases(Func<AliasesDescriptor, IPromise<IAliases>>)
The aliases for the target index
Declaration
public SplitIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
Parameters
Type | Name | Description |
---|---|---|
Func<AliasesDescriptor, IPromise<IAliases>> | selector |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public SplitIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type | Name | Description |
---|---|---|
Time | timeout |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout(Time)
Index(IndexName)
The name of the source index to split
Declaration
public SplitIndexDescriptor Index(IndexName index)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public SplitIndexDescriptor Index<TOther>() where TOther : class
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
Type Parameters
Name | Description |
---|---|
TOther |
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public SplitIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type | Name | Description |
---|---|---|
Time | mastertimeout |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout(Time) instead
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
The settings for the target index
Declaration
public SplitIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Type | Name | Description |
---|---|---|
Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> | selector |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
Timeout(Time)
Explicit operation timeout
Declaration
public SplitIndexDescriptor Timeout(Time timeout)
Parameters
Type | Name | Description |
---|---|---|
Time | timeout |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |
WaitForActiveShards(string)
Set the number of active shards to wait for on the shrunken index before the operation returns.
Declaration
public SplitIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type | Name | Description |
---|---|---|
string | waitforactiveshards |
Returns
Type | Description |
---|---|
SplitIndexDescriptor |