Class DeleteSnapshotRequest
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
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
ConstructorDescriptionConstructs a new delete snapshots requestrepository)
Constructs a new delete snapshots request with repository namerepository, ... snapshots)
Constructs a new delete snapshots request with repository and snapshot names -
Method Summary
Modifier and TypeMethodDescriptionReturns repository namerepository)
[]
Returns snapshot names... snapshots)
Sets snapshot namesvalidate()
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.
, , , , , , , , ,
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( repository, ... snapshots)Constructs a new delete snapshots request with repository and snapshot names- Parameters:
repository
- repository namesnapshots
- snapshot names
-
DeleteSnapshotRequest
public DeleteSnapshotRequest( repository)Constructs a new delete snapshots request with repository name- Parameters:
repository
- repository name
-
DeleteSnapshotRequest
- Throws:
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<DeleteSnapshotRequest>
- Throws:
-
validate
- Specified by:
validate
in classActionRequest
-
repository
public repository) -
repository
public repository()Returns repository name- Returns:
- repository name
-
snapshots
public [] snapshots()Returns snapshot names- Returns:
- snapshot names
-
snapshots
public ... snapshots)Sets snapshot names- Returns:
- this request
-