Class GetSnapshotRequest

Request for Get

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<GetSnapshotRequestParameters>
PlainRequestBase<GetSnapshotRequestParameters>
GetSnapshotRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetSnapshotRequest : PlainRequestBase<GetSnapshotRequestParameters>, IGetSnapshotRequest, IRequest<GetSnapshotRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetSnapshotRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected GetSnapshotRequest()
| Edit this page View Source

GetSnapshotRequest(Name, Names)

/_snapshot/{repository}/{snapshot}

Declaration
public GetSnapshotRequest(Name repository, Names snapshot)
Parameters
Type Name Description
Name repository

this parameter is required
Names snapshot

this parameter is required

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

IgnoreUnavailable

When false, the request returns an error for any snapshots that are unavailable.

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| 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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IGetSnapshotRequest Self { get; }
Property Value
Type Description
IGetSnapshotRequest
| Edit this page View Source

Verbose

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?

Implements

Extension Methods