Class GetSnapshotRequestParameters
Request options for Get
https://opensearch.org/docs/latest
Implements
Inherited Members
Namespace: OpenSearch .Net.Specification.SnapshotApi
Assembly: OpenSearch.Net.dll
Syntax
public class GetSnapshotRequestParameters : RequestParameters<GetSnapshotRequestParameters>, IRequestParametersProperties
| Edit this page View SourceClusterManagerTimeout
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 |
|---|---|
| Time |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }Property Value
| Type | Description |
|---|---|
| Http |
Overrides
| Edit this page View SourceIgnoreUnavailable
When false, the request returns an error for any snapshots that are unavailable.
Declaration
public bool? IgnoreUnavailable { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
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 |
|---|---|
| Time |
SupportsBody
Declaration
public override bool SupportsBody { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
| Edit this page View SourceVerbose
When true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start
and end times of the snapshot, and the number of shards contained in the snapshot.
Declaration
public bool? Verbose { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |