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:

Streamable, Writeable, TaskAwareRequest

public class DeleteSnapshotRequest
extends MasterNodeRequest<DeleteSnapshotRequest>

Delete snapshot request

Delete snapshot request removes the snapshot record from the repository and cleans up all files that are associated with this particular snapshot. 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(java.lang.String repository)	Constructs a new delete snapshots request with repository name
DeleteSnapshotRequest(java.lang.String repository, java.lang.String snapshot)	Constructs a new delete snapshots request with repository and snapshot name

Method Summary

Modifier and Type	Method	Description
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String	repository()	Returns repository name
DeleteSnapshotRequest	repository(java.lang.String repository)
java.lang.String	snapshot()	Returns repository name
DeleteSnapshotRequest	snapshot(java.lang.String snapshot)	Sets snapshot name
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

DeleteSnapshotRequest

public DeleteSnapshotRequest()

Constructs a new delete snapshots request

DeleteSnapshotRequest

public DeleteSnapshotRequest(java.lang.String repository,
                             java.lang.String snapshot)

Constructs a new delete snapshots request with repository and snapshot name

Parameters:

repository - repository name

snapshot - snapshot name

DeleteSnapshotRequest

public DeleteSnapshotRequest(java.lang.String repository)

Constructs a new delete snapshots request with repository name

Parameters:

repository - repository name

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

repository

public DeleteSnapshotRequest repository(java.lang.String repository)

repository

public java.lang.String repository()

Returns repository name

Returns:

repository name

snapshot

public java.lang.String snapshot()

Returns repository name

Returns:

repository name

snapshot

public DeleteSnapshotRequest snapshot(java.lang.String snapshot)

Sets snapshot name

Returns:

this request

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<DeleteSnapshotRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeRequest<DeleteSnapshotRequest>

Throws:

java.io.IOException