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

Class CloneSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.admin.cluster.snapshots.clone.CloneSnapshotRequest

All Implemented Interfaces:

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

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

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.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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CloneSnapshotRequest(String repository, String source, String target, String[] indices)	Creates a clone snapshot request for cloning the given source snapshot's indices into the given target snapshot on the given repository.
CloneSnapshotRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	indices()	Returns the array of indices that the action relates to
CloneSnapshotRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
CloneSnapshotRequest	indicesOptions(IndicesOptions indicesOptions)
String	repository()
String	source()
String	target()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
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

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

CloneSnapshotRequest

public CloneSnapshotRequest(StreamInput in)
                     throws IOException

Throws:

IOException

CloneSnapshotRequest

public CloneSnapshotRequest(String repository,
 String source,
 String target,
 String[] indices)

Creates a clone snapshot request for cloning the given source snapshot's indices into the given target snapshot on the given repository.

Parameters:

repository - repository that source snapshot belongs to and that the target snapshot will be created in

source - source snapshot name

target - target snapshot name

indices - indices to clone from source to target

Method Details

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

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indices

public CloneSnapshotRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public CloneSnapshotRequest indicesOptions(IndicesOptions indicesOptions)

See Also:

• CloneSnapshotRequestBuilder.setIndicesOptions(org.elasticsearch.action.support.IndicesOptions)

repository

public String repository()

target

public String target()

source

public String source()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class TransportRequest