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

Class CreateSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class CreateSnapshotRequest
extends MasterNodeRequest<CreateSnapshotRequest>
implements IndicesRequest.Replaceable, ToXContentObject

Create snapshot request

The only mandatory parameter is repository name. The repository name has to satisfy the following requirements

• be a non-empty string
• must not contain whitespace (tabs or spaces)
• must not contain comma (',')
• must not contain hash sign ('#')
• must not start with underscore ('-')
• must be lowercase
• must not contain invalid file name characters Strings.INVALID_FILENAME_CHARS

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

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

Modifier and Type	Field	Description
static int	MAXIMUM_METADATA_BYTES

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
CreateSnapshotRequest()
CreateSnapshotRequest(String repository, String snapshot)	Constructs a new put repository request with the provided snapshot and repository names
CreateSnapshotRequest(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()
boolean	includeGlobalState()	Returns true if global state should be stored as part of the snapshot
CreateSnapshotRequest	includeGlobalState(boolean includeGlobalState)	Set to true if global state should be stored as part of the snapshot
String[]	indices()	Returns a list of indices that should be included into the snapshot
CreateSnapshotRequest	indices(String... indices)	Sets a list of indices that should be included into the snapshot
CreateSnapshotRequest	indices(List<String> indices)	Sets a list of indices that should be included into the snapshot
IndicesOptions	indicesOptions()	Specifies the indices options.
CreateSnapshotRequest	indicesOptions(IndicesOptions indicesOptions)	Specifies the indices options.
static int	metadataSize(Map<String,Object> userMetadata)
boolean	partial()	Returns true if indices with unavailable shards should be be partially snapshotted.
CreateSnapshotRequest	partial(boolean partial)	Set to true to allow indices with unavailable shards to be partially snapshotted.
String	repository()	Returns repository name
CreateSnapshotRequest	repository(String repository)	Sets repository name
Settings	settings()	Returns repository-specific snapshot settings
CreateSnapshotRequest	settings(String source, XContentType xContentType)	Sets repository-specific snapshot settings in JSON or YAML format
CreateSnapshotRequest	settings(Map<String,Object> source)	Sets repository-specific snapshot settings.
CreateSnapshotRequest	settings(Settings settings)	Sets repository-specific snapshot settings.
CreateSnapshotRequest	settings(Settings.Builder settings)	Sets repository-specific snapshot settings.
String	snapshot()	The snapshot name
CreateSnapshotRequest	snapshot(String snapshot)	Sets the snapshot name
CreateSnapshotRequest	source(Map<String,Object> source)	Parses snapshot definition.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Map<String,Object>	userMetadata()
CreateSnapshotRequest	userMetadata(Map<String,Object> userMetadata)
ActionRequestValidationException	validate()
boolean	waitForCompletion()	Returns true if the request should wait for the snapshot completion before returning
CreateSnapshotRequest	waitForCompletion(boolean waitForCompletion)	If set to true the operation should wait for the snapshot completion 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

Field Detail

MAXIMUM_METADATA_BYTES

public static int MAXIMUM_METADATA_BYTES

Constructor Detail

CreateSnapshotRequest

public CreateSnapshotRequest()

CreateSnapshotRequest

public CreateSnapshotRequest(String repository,
                             String snapshot)

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

Parameters:

repository - repository name

snapshot - snapshot name

CreateSnapshotRequest

public CreateSnapshotRequest(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<CreateSnapshotRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

metadataSize

public static int metadataSize(Map<String,Object> userMetadata)

snapshot

public CreateSnapshotRequest snapshot(String snapshot)

Sets the snapshot name

Parameters:

snapshot - snapshot name

snapshot

public String snapshot()

The snapshot name

Returns:

snapshot name

repository

public CreateSnapshotRequest repository(String repository)

Sets repository name

Parameters:

repository - name

Returns:

this request

repository

public String repository()

Returns repository name

Returns:

repository name

indices

public CreateSnapshotRequest indices(String... indices)

Sets a list of indices that should be included into the 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 supported. An empty list or {"_all"} will snapshot all open indices in the cluster.

Specified by:

indices in interface IndicesRequest.Replaceable

Returns:

this request

indices

public CreateSnapshotRequest indices(List<String> indices)

Sets a list of indices that should be included into the 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 supported. An empty list or {"_all"} will snapshot all open indices in the cluster.

Returns:

this request

indices

public String[] indices()

Returns a list of indices that should be included into the snapshot

Specified by:

indices in interface IndicesRequest

Returns:

list of indices

indicesOptions

public IndicesOptions indicesOptions()

Specifies the indices options. Like what type of requested indices to ignore. For example indices that don't exist.

Specified by:

indicesOptions in interface IndicesRequest

Returns:

the desired behaviour regarding indices options

indicesOptions

public CreateSnapshotRequest indicesOptions(IndicesOptions indicesOptions)

Specifies the indices options. Like what type of requested indices to ignore. For example indices that don't exist.

Parameters:

indicesOptions - the desired behaviour regarding indices options

Returns:

this request

partial

public boolean partial()

Returns true if indices with unavailable shards should be be partially snapshotted.

Returns:

the desired behaviour regarding indices options

partial

public CreateSnapshotRequest partial(boolean partial)

Set to true to allow indices with unavailable shards to be partially snapshotted.

Parameters:

partial - true if indices with unavailable shards should be be partially snapshotted.

Returns:

this request

waitForCompletion

public CreateSnapshotRequest waitForCompletion(boolean waitForCompletion)

If set to true the operation should wait for the snapshot completion before returning. By default, the operation will return as soon as snapshot is initialized. It can be changed by setting this flag to true.

Parameters:

waitForCompletion - true if operation should wait for the snapshot completion

Returns:

this request

waitForCompletion

public boolean waitForCompletion()

Returns true if the request should wait for the snapshot completion before returning

Returns:

true if the request should wait for completion

settings

public CreateSnapshotRequest settings(Settings settings)

Sets repository-specific snapshot settings.

See repository documentation for more information.

Parameters:

settings - repository-specific snapshot settings

Returns:

this request

settings

public CreateSnapshotRequest settings(Settings.Builder settings)

Sets repository-specific snapshot settings.

See repository documentation for more information.

Parameters:

settings - repository-specific snapshot settings

Returns:

this request

settings

public CreateSnapshotRequest settings(String source,
                                      XContentType xContentType)

Sets repository-specific snapshot 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 CreateSnapshotRequest settings(Map<String,Object> source)

Sets repository-specific snapshot settings.

See repository documentation for more information.

Parameters:

source - repository-specific snapshot settings

Returns:

this request

settings

public Settings settings()

Returns repository-specific snapshot settings

Returns:

repository-specific snapshot settings

includeGlobalState

public CreateSnapshotRequest includeGlobalState(boolean includeGlobalState)

Set to true if global state should be stored as part of the snapshot

Parameters:

includeGlobalState - true if global state should be stored

Returns:

this request

includeGlobalState

public boolean includeGlobalState()

Returns true if global state should be stored as part of the snapshot

Returns:

true if global state should be stored as part of the snapshot

userMetadata

public Map<String,Object> userMetadata()

userMetadata

public CreateSnapshotRequest userMetadata(Map<String,Object> userMetadata)

source

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

Parses snapshot definition.

Parameters:

source - snapshot 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