Class SplitIndexDescriptor
A request to split an existing index into a new index, where each original primary
shard is split into two or more primary shards in the new index.
Inheritance
SplitIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class SplitIndexDescriptor : RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>, IDescriptor, ISplitIndexRequest, IRequest<SplitIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
SplitIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected SplitIndexDescriptor()
|
Edit this page
View Source
SplitIndexDescriptor(IndexName, IndexName)
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 Source
Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)
The aliases for the target index
Declaration
public SplitIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
Parameters
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Operation timeout for connection to cluster-manager node.
Declaration
public SplitIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type |
Name |
Description |
Time |
clustermanagertimeout |
|
Returns
|
Edit this page
View Source
Index(IndexName)
Name of the source index to split.
Declaration
public SplitIndexDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public SplitIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Period to wait for a connection to the master 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 SplitIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
The settings for the target index
Declaration
public SplitIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Returns
|
Edit this page
View Source
TaskExecutionTimeout(Time)
Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
Declaration
public SplitIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout)
Parameters
Type |
Name |
Description |
Time |
taskexecutiontimeout |
|
Returns
|
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 SplitIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
The number of shard copies that must be active before proceeding with the operation. Set to all
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).
Declaration
public SplitIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
|
Edit this page
View Source
WaitForCompletion(bool?)
Should this request wait until the operation has completed before returning.
Declaration
public SplitIndexDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type |
Name |
Description |
bool? |
waitforcompletion |
|
Returns
Implements
Extension Methods