Interface IRestoreRequest

Restores a snapshot

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IRestoreRequest : IRequest<RestoreRequestParameters>, IRequest

Properties

| Edit this page View Source

IgnoreIndexSettings

The index settings to ignore as part of the restore operation

Declaration
[DataMember(Name = "ignore_index_settings")]
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
[DataMember(Name = "ignore_unavailable")]
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
[DataMember(Name = "include_aliases")]
bool? IncludeAliases { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IncludeGlobalState

Whether the cluster global state should be included

Declaration
[DataMember(Name = "include_global_state")]
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
[DataMember(Name = "index_settings")]
IUpdateIndexSettingsRequest IndexSettings { get; set; }
Property Value
Type Description
IUpdateIndexSettingsRequest
| Edit this page View Source

Indices

The indices to restore

Declaration
[DataMember(Name = "indices")]
Indices Indices { get; set; }
Property Value
Type Description
Indices
| 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
[DataMember(Name = "partial")]
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
[DataMember(Name = "rename_pattern")]
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
[DataMember(Name = "rename_replacement")]
string RenameReplacement { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RepositoryName

Declaration
[IgnoreDataMember]
Name RepositoryName { get; }
Property Value
Type Description
Name
| Edit this page View Source

Snapshot

Declaration
[IgnoreDataMember]
Name Snapshot { get; }
Property Value
Type Description
Name

Extension Methods