Class SnapshotsStatusRequest
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<SnapshotsStatusRequest>
org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
Get snapshot status request
-
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
ConstructorDescriptionrepository)
Constructs a new get snapshots request with given repository namerepository, [] snapshots)
Constructs a new get snapshots request with given repository name and list of snapshots -
Method Summary
Modifier and TypeMethodDescriptioncreateTask(long id, type, action, TaskId parentTaskId, <,> headers)
Returns the task object that should be used to keep track of the processing of the request.boolean
Returns whether the request permits unavailable snapshots to be ignored.ignoreUnavailable(boolean ignoreUnavailable)
Set totrue
to ignore unavailable snapshots, instead of throwing an exception.Returns repository namerepository)
Sets repository name[]
Returns the names of the snapshots.[] snapshots)
Sets the list of snapshots to be returnedvalidate()
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
getDescription, setParentTask
-
Constructor Details
-
SnapshotsStatusRequest
public SnapshotsStatusRequest() -
SnapshotsStatusRequest
public SnapshotsStatusRequest( repository, [] snapshots)Constructs a new get snapshots request with given repository name and list of snapshots- Parameters:
repository
- repository namesnapshots
- list of snapshots
-
SnapshotsStatusRequest
- Throws:
-
SnapshotsStatusRequest
public SnapshotsStatusRequest( repository)Constructs a new get snapshots request with given repository name- Parameters:
repository
- repository name
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<SnapshotsStatusRequest>
- Throws:
-
validate
- Specified by:
validate
in classActionRequest
-
createTask
Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request. -
repository
public repository)Sets repository name- Parameters:
repository
- repository name- Returns:
- this request
-
repository
public repository()Returns repository name- Returns:
- repository name
-
snapshots
public [] snapshots()Returns the names of the snapshots.- Returns:
- the names of snapshots
-
snapshots
public [] snapshots)Sets the list of snapshots to be returned- Returns:
- this request
-