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
,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 requestDeleteSnapshotRequest(java.lang.String repository)
Constructs a new delete snapshots request with repository nameDeleteSnapshotRequest(java.lang.String repository, java.lang.String snapshot)
Constructs a new delete snapshots request with repository and snapshot nameDeleteSnapshotRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String
repository()
Returns repository nameDeleteSnapshotRequest
repository(java.lang.String repository)
java.lang.String
snapshot()
Returns repository nameDeleteSnapshotRequest
snapshot(java.lang.String snapshot)
Sets snapshot nameActionRequestValidationException
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.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 Details
-
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 namesnapshot
- snapshot name
-
DeleteSnapshotRequest
public DeleteSnapshotRequest(java.lang.String repository)Constructs a new delete snapshots request with repository name- Parameters:
repository
- repository name
-
DeleteSnapshotRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<DeleteSnapshotRequest>
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-
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
Sets snapshot name- Returns:
- this request
-