Class RestoreRequest

Restores a snapshot

Inheritance
object
RequestBase<RestoreRequestParameters>
PlainRequestBase<RestoreRequestParameters>
RestoreRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RestoreRequest : PlainRequestBase<RestoreRequestParameters>, IRestoreRequest, IRequest<RestoreRequestParameters>, IRequest

Constructors

| Edit this page View Source

RestoreRequest()

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

Declaration
protected RestoreRequest()
| Edit this page View Source

RestoreRequest(Name, Name)

/_snapshot/{repository}/{snapshot}/_restore

Declaration
public RestoreRequest(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

IgnoreIndexSettings

The index settings to ignore as part of the restore operation

Declaration
public List<string> IgnoreIndexSettings { get; set; }
Property Value
Type Description
List<string>
| Edit this page View Source

IgnoreUnavailable

Whether indices specified that do not exist should be ignored.

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

IncludeAliases

Whether to include aliases as part of the restore

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

IncludeGlobalState

Whether the cluster global state should be included

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

IndexSettings

The index settings that should be applied as part of the restore operation. Some settings cannot be changed as part of a restore operation, for example, the number of shards.

Declaration
public IUpdateIndexSettingsRequest IndexSettings { get; set; }
Property Value
Type Description
IUpdateIndexSettingsRequest
| Edit this page View Source

Indices

The indices to restore

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

MasterTimeout

Explicit operation timeout for connection to cluster-manager node.

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

Partial

Allow partial restore for indices that don't have snapshots of all shards available.

By default, the entire restore operation will fail if one or more indices participating in the operation don’t have snapshots of all shards available. It can occur if some shards failed to snapshot for example. It is still possible to restore such indices by setting Partial to true. Only successfully snapshotted shards will be restored in this case and all missing shards will be recreated empty.
Declaration
public bool? Partial { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

RenamePattern

A pattern to use to rename restored indices. The pattern can be used to capture parts of the original index name and used within RenameReplacement

Declaration
public string RenamePattern { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RenameReplacement

A replacement to use to rename restored indices. Used in conjunction with RenamePattern.

Declaration
public string RenameReplacement { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Self

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

WaitForCompletion

-| Whether to return a response after the restore operation has completed. When false, the request returns a response when the restore operation initializes. When true, the request returns a response when the restore operation completes.

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods