Class GetSnapshotDescriptor

Descriptor for Get

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

GetSnapshotDescriptor()

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

Declaration
protected GetSnapshotDescriptor()
| Edit this page View Source

GetSnapshotDescriptor(Name, Names)

/_snapshot/{repository}/{snapshot}

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

this parameter is required
Names snapshot

this parameter is required

Methods

| Edit this page View Source

ClusterManagerTimeout(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 GetSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
GetSnapshotDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

IgnoreUnavailable(bool?)

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

Declaration
public GetSnapshotDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
GetSnapshotDescriptor
| Edit this page View Source

MasterTimeout(Time)

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 GetSnapshotDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetSnapshotDescriptor
| Edit this page View Source

Verbose(bool?)

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 GetSnapshotDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
GetSnapshotDescriptor

Implements

Extension Methods