Class CloneIndexRequest
A request to the clone index API
Inheritance
CloneIndexRequest
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CloneIndexRequest : PlainRequestBase<CloneIndexRequestParameters>, ICloneIndexRequest, IRequest<CloneIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceCloneIndexRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CloneIndexRequest()
CloneIndexRequest(IndexName, IndexName)
/{index}/_clone/{target}
Declaration
public CloneIndexRequest(IndexName index, IndexName target)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
IndexName | target | this parameter is required |
Properties
| Edit this page View SourceAliases
The aliases to apply to the target index
Declaration
public IAliases Aliases { get; set; }
Property Value
Type | Description |
---|---|
IAliases |
ClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
MasterTimeout
Specify timeout for connection to master node
Declaration
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
Self
Declaration
protected ICloneIndexRequest Self { get; }
Property Value
Type | Description |
---|---|
ICloneIndexRequest |
Settings
The settings to apply to the target index
Declaration
public IIndexSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
IIndexSettings |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
WaitForActiveShards
Set the number of active shards to wait for on the cloned index before the operation returns.
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |