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

Class DeleteSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

org.elasticsearch.action.admin.cluster.snapshots.delete.DeleteSnapshotRequest

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class DeleteSnapshotRequest
extends MasterNodeRequest<DeleteSnapshotRequest>

Delete snapshot request

Delete snapshot request removes snapshots from the repository and cleans up all files that are associated with the snapshots. All files that are shared with at least one other existing snapshot are left intact.

Nested Class Summary

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

TransportRequest.Empty

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

Constructor Summary

Constructors

Constructor	Description
DeleteSnapshotRequest()	Constructs a new delete snapshots request
DeleteSnapshotRequest(String repository)	Constructs a new delete snapshots request with repository name
DeleteSnapshotRequest(String repository, String... snapshots)	Constructs a new delete snapshots request with repository and snapshot names
DeleteSnapshotRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	repository()	Returns repository name
DeleteSnapshotRequest	repository(String repository)
String[]	snapshots()	Returns snapshot names
DeleteSnapshotRequest	snapshots(String... snapshots)	Sets snapshot names
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, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, 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.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

DeleteSnapshotRequest

public DeleteSnapshotRequest()

Constructs a new delete snapshots request

DeleteSnapshotRequest

public DeleteSnapshotRequest(String repository,
 String... snapshots)

Constructs a new delete snapshots request with repository and snapshot names

Parameters:

repository - repository name

snapshots - snapshot names

DeleteSnapshotRequest

public DeleteSnapshotRequest(String repository)

Constructs a new delete snapshots request with repository name

Parameters:

repository - repository name

DeleteSnapshotRequest

public DeleteSnapshotRequest(StreamInput in)
                      throws IOException

Throws:

IOException

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

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

repository

public DeleteSnapshotRequest repository(String repository)

repository

public String repository()

Returns repository name

Returns:

repository name

snapshots

public String[] snapshots()

Returns snapshot names

Returns:

snapshot names

snapshots

public DeleteSnapshotRequest snapshots(String... snapshots)

Sets snapshot names

Returns:

this request