Package org.elasticsearch.action.admin.cluster.snapshots.restore

Class RestoreSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<RestoreSnapshotRequest>

org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class RestoreSnapshotRequest
extends MasterNodeRequest<RestoreSnapshotRequest>
implements ToXContentObject

Restore snapshot request

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RestoreSnapshotRequest()
RestoreSnapshotRequest(String repository, String snapshot)	Constructs a new put repository request with the provided repository and snapshot names.
RestoreSnapshotRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
int	hashCode()
String[]	ignoreIndexSettings()	Returns the list of index settings and index settings groups that shouldn't be restored from snapshot
RestoreSnapshotRequest	ignoreIndexSettings(String... ignoreIndexSettings)	Sets the list of index settings and index settings groups that shouldn't be restored from snapshot
RestoreSnapshotRequest	ignoreIndexSettings(List<String> ignoreIndexSettings)	Sets the list of index settings and index settings groups that shouldn't be restored from snapshot
boolean	includeAliases()	Returns true if aliases should be restored from this snapshot
RestoreSnapshotRequest	includeAliases(boolean includeAliases)	If set to true the restore procedure will restore aliases
boolean	includeGlobalState()	Returns true if global state should be restored from this snapshot
RestoreSnapshotRequest	includeGlobalState(boolean includeGlobalState)	If set to true the restore procedure will restore global cluster state.
Settings	indexSettings()	Returns settings that should be added/changed in all restored indices
RestoreSnapshotRequest	indexSettings(String source, XContentType xContentType)	Sets settings that should be added/changed in all restored indices
RestoreSnapshotRequest	indexSettings(Map<String,Object> source)	Sets settings that should be added/changed in all restored indices
RestoreSnapshotRequest	indexSettings(Settings settings)	Sets settings that should be added/changed in all restored indices
RestoreSnapshotRequest	indexSettings(Settings.Builder settings)	Sets settings that should be added/changed in all restored indices
String[]	indices()	Returns list of indices that should be restored from snapshot
RestoreSnapshotRequest	indices(String... indices)	Sets the list of indices that should be restored from snapshot
RestoreSnapshotRequest	indices(List<String> indices)	Sets the list of indices that should be restored from snapshot
IndicesOptions	indicesOptions()	Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
RestoreSnapshotRequest	indicesOptions(IndicesOptions indicesOptions)	Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
boolean	partial()	Returns true if indices with failed to snapshot shards should be partially restored.
RestoreSnapshotRequest	partial(boolean partial)	Set to true to allow indices with failed to snapshot shards should be partially restored.
String	renamePattern()	Returns rename pattern
RestoreSnapshotRequest	renamePattern(String renamePattern)	Sets rename pattern that should be applied to restored indices.
String	renameReplacement()	Returns rename replacement
RestoreSnapshotRequest	renameReplacement(String renameReplacement)	Sets rename replacement
String	repository()	Returns repository name
RestoreSnapshotRequest	repository(String repository)	Sets repository name
Settings	settings()	Returns repository-specific restore settings
RestoreSnapshotRequest	settings(String source, XContentType xContentType)	Sets repository-specific restore settings in JSON or YAML format
RestoreSnapshotRequest	settings(Map<String,Object> source)	Sets repository-specific restore settings
RestoreSnapshotRequest	settings(Settings settings)	Sets repository-specific restore settings.
RestoreSnapshotRequest	settings(Settings.Builder settings)	Sets repository-specific restore settings.
String	snapshot()	Returns the name of the snapshot.
RestoreSnapshotRequest	snapshot(String snapshot)	Sets the name of the snapshot.
RestoreSnapshotRequest	source(Map<String,Object> source)	Parses restore definition
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
boolean	waitForCompletion()	Returns wait for completion setting
RestoreSnapshotRequest	waitForCompletion(boolean waitForCompletion)	If this parameter is set to true the operation will wait for completion of restore process before returning.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

RestoreSnapshotRequest

public RestoreSnapshotRequest()

RestoreSnapshotRequest

public RestoreSnapshotRequest(String repository,
                              String snapshot)

Constructs a new put repository request with the provided repository and snapshot names.

Parameters:

repository - repository name

snapshot - snapshot name

RestoreSnapshotRequest

public RestoreSnapshotRequest(StreamInput in)
                       throws IOException

Throws:

IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeRequest<RestoreSnapshotRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

snapshot

public RestoreSnapshotRequest snapshot(String snapshot)

Sets the name of the snapshot.

Parameters:

snapshot - snapshot name

Returns:

this request

snapshot

public String snapshot()

Returns the name of the snapshot.

Returns:

snapshot name

repository

public RestoreSnapshotRequest repository(String repository)

Sets repository name

Parameters:

repository - repository name

Returns:

this request

repository

public String repository()

Returns repository name

Returns:

repository name

indices

public RestoreSnapshotRequest indices(String... indices)

Sets the list of indices that should be restored from snapshot

The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open indices in the snapshot.

Parameters:

indices - list of indices

Returns:

this request

indices

public RestoreSnapshotRequest indices(List<String> indices)

Sets the list of indices that should be restored from snapshot

The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open indices in the snapshot.

Parameters:

indices - list of indices

Returns:

this request

indices

public String[] indices()

Returns list of indices that should be restored from snapshot

indicesOptions

public IndicesOptions indicesOptions()

Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.

Returns:

the desired behaviour regarding indices to ignore and wildcard indices expression

indicesOptions

public RestoreSnapshotRequest indicesOptions(IndicesOptions indicesOptions)

Specifies what type of requested indices to ignore and how to deal with wildcard expressions. For example indices that don't exist.

Parameters:

indicesOptions - the desired behaviour regarding indices to ignore and wildcard indices expressions

Returns:

this request

renamePattern

public RestoreSnapshotRequest renamePattern(String renamePattern)

Sets rename pattern that should be applied to restored indices.

Indices that match the rename pattern will be renamed according to renameReplacement(String). The rename pattern is applied according to the Matcher.appendReplacement(StringBuffer, String) The request will fail if two or more indices will be renamed into the same name.

Parameters:

renamePattern - rename pattern

Returns:

this request

renamePattern

public String renamePattern()

Returns rename pattern

Returns:

rename pattern

renameReplacement

public RestoreSnapshotRequest renameReplacement(String renameReplacement)

Sets rename replacement

See renamePattern(String) for more information.

Parameters:

renameReplacement - rename replacement

renameReplacement

public String renameReplacement()

Returns rename replacement

Returns:

rename replacement

waitForCompletion

public RestoreSnapshotRequest waitForCompletion(boolean waitForCompletion)

If this parameter is set to true the operation will wait for completion of restore process before returning.

Parameters:

waitForCompletion - if true the operation will wait for completion

Returns:

this request

waitForCompletion

public boolean waitForCompletion()

Returns wait for completion setting

Returns:

true if the operation will wait for completion

partial

public boolean partial()

Returns true if indices with failed to snapshot shards should be partially restored.

Returns:

true if indices with failed to snapshot shards should be partially restored

partial

public RestoreSnapshotRequest partial(boolean partial)

Set to true to allow indices with failed to snapshot shards should be partially restored.

Parameters:

partial - true if indices with failed to snapshot shards should be partially restored.

Returns:

this request

settings

public RestoreSnapshotRequest settings(Settings settings)

Sets repository-specific restore settings.

See repository documentation for more information.

Parameters:

settings - repository-specific snapshot settings

Returns:

this request

settings

public RestoreSnapshotRequest settings(Settings.Builder settings)

Sets repository-specific restore settings.

See repository documentation for more information.

Parameters:

settings - repository-specific snapshot settings

Returns:

this request

settings

public RestoreSnapshotRequest settings(String source,
                                       XContentType xContentType)

Sets repository-specific restore settings in JSON or YAML format

See repository documentation for more information.

Parameters:

source - repository-specific snapshot settings

xContentType - the content type of the source

Returns:

this request

settings

public RestoreSnapshotRequest settings(Map<String,Object> source)

Sets repository-specific restore settings

See repository documentation for more information.

Parameters:

source - repository-specific snapshot settings

Returns:

this request

settings

public Settings settings()

Returns repository-specific restore settings

Returns:

restore settings

ignoreIndexSettings

public RestoreSnapshotRequest ignoreIndexSettings(String... ignoreIndexSettings)

Sets the list of index settings and index settings groups that shouldn't be restored from snapshot

ignoreIndexSettings

public RestoreSnapshotRequest ignoreIndexSettings(List<String> ignoreIndexSettings)

Sets the list of index settings and index settings groups that shouldn't be restored from snapshot

ignoreIndexSettings

public String[] ignoreIndexSettings()

Returns the list of index settings and index settings groups that shouldn't be restored from snapshot

includeGlobalState

public RestoreSnapshotRequest includeGlobalState(boolean includeGlobalState)

If set to true the restore procedure will restore global cluster state.

The global cluster state includes persistent settings and index template definitions.

Parameters:

includeGlobalState - true if global state should be restored from the snapshot

Returns:

this request

includeGlobalState

public boolean includeGlobalState()

Returns true if global state should be restored from this snapshot

Returns:

true if global state should be restored

includeAliases

public RestoreSnapshotRequest includeAliases(boolean includeAliases)

If set to true the restore procedure will restore aliases

Parameters:

includeAliases - true if aliases should be restored from the snapshot

Returns:

this request

includeAliases

public boolean includeAliases()

Returns true if aliases should be restored from this snapshot

Returns:

true if aliases should be restored

indexSettings

public RestoreSnapshotRequest indexSettings(Settings settings)

Sets settings that should be added/changed in all restored indices

indexSettings

public RestoreSnapshotRequest indexSettings(Settings.Builder settings)

Sets settings that should be added/changed in all restored indices

indexSettings

public RestoreSnapshotRequest indexSettings(String source,
                                            XContentType xContentType)

Sets settings that should be added/changed in all restored indices

indexSettings

public RestoreSnapshotRequest indexSettings(Map<String,Object> source)

Sets settings that should be added/changed in all restored indices

indexSettings

public Settings indexSettings()

Returns settings that should be added/changed in all restored indices

source

public RestoreSnapshotRequest source(Map<String,Object> source)

Parses restore definition

Parameters:

source - restore definition

Returns:

this request

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object