Class SnapshotRequest

Request for Snapshot

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

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

Constructors

| Edit this page View Source

SnapshotRequest()

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

Declaration
protected SnapshotRequest()
| Edit this page View Source

SnapshotRequest(Name, Name)

/_snapshot/{repository}/{snapshot}

Declaration
public SnapshotRequest(Name repository, Name snapshot)
Parameters
Type Name Description
Name repository

this parameter is required
Name 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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IncludeGlobalState

Declaration
public bool? IncludeGlobalState { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Indices

Declaration
public Indices Indices { get; set; }
Property Value
Type Description
Indices
| 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

Metadata

Declaration
public IDictionary<string, object> Metadata { get; set; }
Property Value
Type Description
IDictionary<string, object>
| Edit this page View Source

Partial

Declaration
public bool? Partial { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Self

Declaration
protected ISnapshotRequest Self { get; }
Property Value
Type Description
ISnapshotRequest
| 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