Class DeleteSnapshotDescriptor
Descriptor for Delete
https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/
Inheritance
RequestDescriptorBase <DeleteSnapshotDescriptor , DeleteSnapshotRequestParameters , IDeleteSnapshotRequest >
DeleteSnapshotDescriptor
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class DeleteSnapshotDescriptor : RequestDescriptorBase<DeleteSnapshotDescriptor, DeleteSnapshotRequestParameters, IDeleteSnapshotRequest>, IDescriptor, IDeleteSnapshotRequest, IRequest<DeleteSnapshotRequestParameters>, IRequestConstructors
| Edit this page View SourceDeleteSnapshotDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected DeleteSnapshotDescriptor()DeleteSnapshotDescriptor(Name, Name)
/_snapshot/{repository}/{snapshot}
Declaration
public DeleteSnapshotDescriptor(Name repository, Name snapshot)Parameters
| Type | Name | Description |
|---|---|---|
| Name | repository | this parameter is required |
| Name | snapshot | this parameter is required |
Methods
| Edit this page View SourceClusterManagerTimeout(Time)
The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.
Declaration
public DeleteSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | clustermanagertimeout |
Returns
| Type | Description |
|---|---|
| Delete |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
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 DeleteSnapshotDescriptor MasterTimeout(Time mastertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | mastertimeout |
Returns
| Type | Description |
|---|---|
| Delete |