Class RestoreDescriptor
Inheritance
RestoreDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class RestoreDescriptor : RequestDescriptorBase<RestoreDescriptor, RestoreRequestParameters, IRestoreRequest>, IDescriptor, IRestoreRequest, IRequest<RestoreRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
RestoreDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected RestoreDescriptor()
|
Edit this page
View Source
RestoreDescriptor(Name, Name)
/_snapshot/{repository}/{snapshot}/_restore
Declaration
public RestoreDescriptor(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)
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 RestoreDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
| Type |
Name |
Description |
| Time |
clustermanagertimeout |
|
Returns
|
Edit this page
View Source
IgnoreIndexSettings(List<string>)
The index settings to ignore as part of the restore operation
Declaration
public RestoreDescriptor IgnoreIndexSettings(List<string> ignoreIndexSettings)
Parameters
| Type |
Name |
Description |
| List<string> |
ignoreIndexSettings |
|
Returns
|
Edit this page
View Source
IgnoreIndexSettings(params string[])
The index settings to ignore as part of the restore operation
Declaration
public RestoreDescriptor IgnoreIndexSettings(params string[] ignoreIndexSettings)
Parameters
| Type |
Name |
Description |
| string[] |
ignoreIndexSettings |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether indices specified that do not exist
should be ignored.
Declaration
public RestoreDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true)
Parameters
| Type |
Name |
Description |
| bool? |
ignoreUnavailable |
|
Returns
|
Edit this page
View Source
IncludeAliases(bool?)
Whether to include aliases as part of the restore
Declaration
public RestoreDescriptor IncludeAliases(bool? includeAliases = true)
Parameters
| Type |
Name |
Description |
| bool? |
includeAliases |
|
Returns
|
Edit this page
View Source
IncludeGlobalState(bool?)
Whether the cluster global state should be included
Declaration
public RestoreDescriptor IncludeGlobalState(bool? includeGlobalState = true)
Parameters
| Type |
Name |
Description |
| bool? |
includeGlobalState |
|
Returns
|
Edit this page
View Source
Index(IndexName)
Declaration
public RestoreDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
IndexSettings(Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest>)
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 RestoreDescriptor IndexSettings(Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest> settingsSelector)
Parameters
Returns
|
Edit this page
View Source
Index<T>()
Declaration
public RestoreDescriptor Index<T>() where T : class
Returns
Type Parameters
|
Edit this page
View Source
Indices(Indices)
Declaration
public RestoreDescriptor Indices(Indices indices)
Parameters
| Type |
Name |
Description |
| Indices |
indices |
|
Returns
|
Edit this page
View Source
MasterTimeout(Time)
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 RestoreDescriptor MasterTimeout(Time mastertimeout)
Parameters
| Type |
Name |
Description |
| Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Partial(bool?)
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 RestoreDescriptor Partial(bool? partial = true)
Parameters
| Type |
Name |
Description |
| bool? |
partial |
|
Returns
|
Edit this page
View Source
RenamePattern(string)
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 RestoreDescriptor RenamePattern(string renamePattern)
Parameters
| Type |
Name |
Description |
| string |
renamePattern |
|
Returns
|
Edit this page
View Source
RenameReplacement(string)
A replacement to use to rename restored indices. Used
in conjunction with RenamePattern.
Declaration
public RestoreDescriptor RenameReplacement(string renameReplacement)
Parameters
| Type |
Name |
Description |
| string |
renameReplacement |
|
Returns
|
Edit this page
View Source
WaitForCompletion(bool?)
-| 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 RestoreDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
| Type |
Name |
Description |
| bool? |
waitforcompletion |
|
Returns
Implements
Extension Methods