Class SnapshotRequestParameters

Request options for Snapshot

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/

Inheritance
object
RequestParameters<SnapshotRequestParameters>
SnapshotRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.SnapshotApi
Assembly: OpenSearch.Net.dll
Syntax
public class SnapshotRequestParameters : RequestParameters<SnapshotRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

ClusterManagerTimeout

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 TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

MasterTimeout

Period to wait for a connection to the cluster-manager 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 TimeSpan MasterTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

WaitForCompletion

When true, the request returns a response when the snapshot is complete. When false, the request returns a response when the snapshot initializes.

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods