Class CloneSnapshotDescriptor
Descriptor for Clone
https://opensearch.org/docs/latest
Inheritance
RequestDescriptorBase<CloneSnapshotDescriptor, CloneSnapshotRequestParameters, ICloneSnapshotRequest>
CloneSnapshotDescriptor
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CloneSnapshotDescriptor : RequestDescriptorBase<CloneSnapshotDescriptor, CloneSnapshotRequestParameters, ICloneSnapshotRequest>, IDescriptor, ICloneSnapshotRequest, IRequest<CloneSnapshotRequestParameters>, IRequest
Constructors
| Edit this page View SourceCloneSnapshotDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CloneSnapshotDescriptor()
CloneSnapshotDescriptor(Name, Name, Name)
/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
Declaration
public CloneSnapshotDescriptor(Name repository, Name snapshot, Name targetSnapshot)
Parameters
Type | Name | Description |
---|---|---|
Name | repository | this parameter is required |
Name | snapshot | this parameter is required |
Name | targetSnapshot | this parameter is required |
Methods
| Edit this page View SourceClusterManagerTimeout(Time)
Operation timeout for connection to cluster-manager node.
Declaration
public CloneSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type | Name | Description |
---|---|---|
Time | clustermanagertimeout |
Returns
Type | Description |
---|---|
CloneSnapshotDescriptor |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
Index(IndexName)
The indices to restore
Declaration
public CloneSnapshotDescriptor Index(IndexName index)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index |
Returns
Type | Description |
---|---|
CloneSnapshotDescriptor |
Index<T>()
The indices to restore
Declaration
public CloneSnapshotDescriptor Index<T>() where T : class
Returns
Type | Description |
---|---|
CloneSnapshotDescriptor |
Type Parameters
Name | Description |
---|---|
T |
Indices(Indices)
The indices to restore
Declaration
public CloneSnapshotDescriptor Indices(Indices indices)
Parameters
Type | Name | Description |
---|---|---|
Indices | indices |
Returns
Type | Description |
---|---|
CloneSnapshotDescriptor |
MasterTimeout(Time)
Explicit operation timeout for connection to cluster-manager node.
Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CloneSnapshotDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type | Name | Description |
---|---|---|
Time | mastertimeout |
Returns
Type | Description |
---|---|
CloneSnapshotDescriptor |