Package org.elasticsearch.snapshots
Class RestoreService.RestoreRequest
- java.lang.Object
-
- org.elasticsearch.snapshots.RestoreService.RestoreRequest
-
- Enclosing class:
- RestoreService
public static class RestoreService.RestoreRequest extends java.lang.Object
Restore snapshot request
-
-
Constructor Summary
Constructors Constructor Description RestoreRequest(java.lang.String repositoryName, java.lang.String snapshotName, java.lang.String[] indices, IndicesOptions indicesOptions, java.lang.String renamePattern, java.lang.String renameReplacement, Settings settings, TimeValue masterNodeTimeout, boolean includeGlobalState, boolean partial, boolean includeAliases, Settings indexSettings, java.lang.String[] ignoreIndexSettings, java.lang.String cause)
Constructs new restore request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
cause()
Returns restore operation causejava.lang.String[]
ignoreIndexSettings()
Returns index settings that that shouldn't be restoredboolean
includeAliases()
Returns true if aliases should be restore during this restore operationboolean
includeGlobalState()
Returns true if global state should be restore during this restore operationSettings
indexSettings()
Returns index settings that should be changed on restorejava.lang.String[]
indices()
Return the list of indices to be restoredIndicesOptions
indicesOptions()
Returns indices option flagsTimeValue
masterNodeTimeout()
Return master node timeoutboolean
partial()
Returns true if incomplete indices will be restoredjava.lang.String
renamePattern()
Returns rename patternjava.lang.String
renameReplacement()
Returns replacement patternjava.lang.String
repositoryName()
Returns repository nameSettings
settings()
Returns repository-specific restore settingsjava.lang.String
snapshotName()
Returns snapshot name
-
-
-
Constructor Detail
-
RestoreRequest
public RestoreRequest(java.lang.String repositoryName, java.lang.String snapshotName, java.lang.String[] indices, IndicesOptions indicesOptions, java.lang.String renamePattern, java.lang.String renameReplacement, Settings settings, TimeValue masterNodeTimeout, boolean includeGlobalState, boolean partial, boolean includeAliases, Settings indexSettings, java.lang.String[] ignoreIndexSettings, java.lang.String cause)
Constructs new restore request- Parameters:
repositoryName
- repositoryNamesnapshotName
- snapshotNameindices
- list of indices to restoreindicesOptions
- indices optionsrenamePattern
- pattern to rename indicesrenameReplacement
- replacement for renamed indicessettings
- repository specific restore settingsmasterNodeTimeout
- master node timeoutincludeGlobalState
- include global state into restorepartial
- allow partial restoreindexSettings
- index settings that should be changed on restoreignoreIndexSettings
- index settings that shouldn't be restoredcause
- cause for restoring the snapshot
-
-
Method Detail
-
cause
public java.lang.String cause()
Returns restore operation cause- Returns:
- restore operation cause
-
repositoryName
public java.lang.String repositoryName()
Returns repository name- Returns:
- repository name
-
snapshotName
public java.lang.String snapshotName()
Returns snapshot name- Returns:
- snapshot name
-
indices
public java.lang.String[] indices()
Return the list of indices to be restored- Returns:
- the list of indices
-
indicesOptions
public IndicesOptions indicesOptions()
Returns indices option flags- Returns:
- indices options flags
-
renamePattern
public java.lang.String renamePattern()
Returns rename pattern- Returns:
- rename pattern
-
renameReplacement
public java.lang.String renameReplacement()
Returns replacement pattern- Returns:
- replacement pattern
-
settings
public Settings settings()
Returns repository-specific restore settings- Returns:
- restore settings
-
includeGlobalState
public boolean includeGlobalState()
Returns true if global state should be restore during this restore operation- Returns:
- restore global state flag
-
partial
public boolean partial()
Returns true if incomplete indices will be restored- Returns:
- partial indices restore flag
-
includeAliases
public boolean includeAliases()
Returns true if aliases should be restore during this restore operation- Returns:
- restore aliases state flag
-
indexSettings
public Settings indexSettings()
Returns index settings that should be changed on restore- Returns:
- restore aliases state flag
-
ignoreIndexSettings
public java.lang.String[] ignoreIndexSettings()
Returns index settings that that shouldn't be restored- Returns:
- restore aliases state flag
-
masterNodeTimeout
public TimeValue masterNodeTimeout()
Return master node timeout- Returns:
- master node timeout
-
-