Class CloneIndexDescriptor
Descriptor for Clone
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/clone/
Inheritance
CloneIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class CloneIndexDescriptor : RequestDescriptorBase<CloneIndexDescriptor, CloneIndexRequestParameters, ICloneIndexRequest>, IDescriptor, ICloneIndexRequest, IRequest<CloneIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
CloneIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CloneIndexDescriptor()
|
Edit this page
View Source
CloneIndexDescriptor(IndexName, IndexName)
Declaration
public CloneIndexDescriptor(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 to apply to the target index
Declaration
public CloneIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
Parameters
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public CloneIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
Index(IndexName)
The name of the source index to clone
Declaration
public CloneIndexDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public CloneIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public CloneIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
The settings to apply to the target index
Declaration
public CloneIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public CloneIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Set the number of active shards to wait for on the cloned index before the operation returns.
Declaration
public CloneIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods