Module org.elasticsearch.server
Class SnapshotsStatusRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<SnapshotsStatusRequest>
org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequest
- All Implemented Interfaces:
Writeable,RefCounted,TaskAwareRequest
Get snapshot status request
-
Nested Class Summary
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
TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionSnapshotsStatusRequest(TimeValue masterNodeTimeout) SnapshotsStatusRequest(TimeValue masterNodeTimeout, String repository) Constructs a new get snapshots request with given repository name -
Method Summary
Modifier and TypeMethodDescriptionReturns the task object that should be used to keep track of the processing of the request.Returns optional description of the request to be displayed by the task managerbooleanReturns whether the request permits unavailable snapshots to be ignored.ignoreUnavailable(boolean ignoreUnavailable) Set totrueto ignore unavailable snapshots, instead of throwing an exception.Returns repository namerepository(String repository) Sets repository nameString[]Returns the names of the snapshots.Sets the list of snapshots to be returnedvalidate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
infiniteMasterNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
-
Constructor Details
-
SnapshotsStatusRequest
-
SnapshotsStatusRequest
- Throws:
IOException
-
SnapshotsStatusRequest
Constructs a new get snapshots request with given repository name- Parameters:
repository- repository name
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classMasterNodeRequest<SnapshotsStatusRequest>- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request. -
repository
Sets repository name- Parameters:
repository- repository name- Returns:
- this request
-
repository
Returns repository name- Returns:
- repository name
-
snapshots
Returns the names of the snapshots.- Returns:
- the names of snapshots
-
snapshots
Sets the list of snapshots to be returned- Returns:
- this request
-
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager
-