Class SnapshotDescriptor

Descriptor for Snapshot

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

Inheritance
object
RequestBase<SnapshotRequestParameters>
RequestDescriptorBase<SnapshotDescriptor, SnapshotRequestParameters, ISnapshotRequest>
SnapshotDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SnapshotDescriptor : RequestDescriptorBase<SnapshotDescriptor, SnapshotRequestParameters, ISnapshotRequest>, IDescriptor, ISnapshotRequest, IRequest<SnapshotRequestParameters>, IRequest

Constructors

| Edit this page View Source

SnapshotDescriptor()

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

Declaration
protected SnapshotDescriptor()
| Edit this page View Source

SnapshotDescriptor(Name, Name)

/_snapshot/{repository}/{snapshot}

Declaration
public SnapshotDescriptor(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 Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public SnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
SnapshotDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

IgnoreUnavailable(bool?)

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

IncludeGlobalState(bool?)

Declaration
public SnapshotDescriptor IncludeGlobalState(bool? includeGlobalState = true)
Parameters
Type Name Description
bool? includeGlobalState
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

Index(IndexName)

Declaration
public SnapshotDescriptor Index(IndexName index)
Parameters
Type Name Description
IndexName index
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

Index<T>()

Declaration
public SnapshotDescriptor Index<T>() where T : class
Returns
Type Description
SnapshotDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Indices(Indices)

Declaration
public SnapshotDescriptor Indices(Indices indices)
Parameters
Type Name Description
Indices indices
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the master 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 SnapshotDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

Metadata(IDictionary<string, object>)

Declaration
public SnapshotDescriptor Metadata(IDictionary<string, object> metadata)
Parameters
Type Name Description
IDictionary<string, object> metadata
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

Metadata(Func<FluentDictionary<string, object>, IDictionary<string, object>>)

Declaration
public SnapshotDescriptor Metadata(Func<FluentDictionary<string, object>, IDictionary<string, object>> selector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, IDictionary<string, object>> selector
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

Partial(bool?)

Declaration
public SnapshotDescriptor Partial(bool? partial = true)
Parameters
Type Name Description
bool? partial
Returns
Type Description
SnapshotDescriptor
| Edit this page View Source

WaitForCompletion(bool?)

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

Declaration
public SnapshotDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
SnapshotDescriptor

Implements

Extension Methods