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 and 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

Modifier and Type	Method and Description
java.lang.String	cause() Returns restore operation cause
java.lang.String[]	ignoreIndexSettings() Returns index settings that that shouldn't be restored
boolean	includeAliases() Returns true if aliases should be restore during this restore operation
boolean	includeGlobalState() Returns true if global state should be restore during this restore operation
Settings	indexSettings() Returns index settings that should be changed on restore
java.lang.String[]	indices() Return the list of indices to be restored
IndicesOptions	indicesOptions() Returns indices option flags
TimeValue	masterNodeTimeout() Return master node timeout
boolean	partial() Returns true if incomplete indices will be restored
java.lang.String	renamePattern() Returns rename pattern
java.lang.String	renameReplacement() Returns replacement pattern
java.lang.String	repositoryName() Returns repository name
Settings	settings() Returns repository-specific restore settings
java.lang.String	snapshotName() Returns snapshot name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 - repositoryName

snapshotName - snapshotName

indices - list of indices to restore

indicesOptions - indices options

renamePattern - pattern to rename indices

renameReplacement - replacement for renamed indices

settings - repository specific restore settings

masterNodeTimeout - master node timeout

includeGlobalState - include global state into restore

partial - allow partial restore

indexSettings - index settings that should be changed on restore

ignoreIndexSettings - index settings that shouldn't be restored

cause - 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