Module org.elasticsearch.xcore
Class MountSearchableSnapshotRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<MountSearchableSnapshotRequest>
org.elasticsearch.xpack.core.searchablesnapshots.MountSearchableSnapshotRequest
- All Implemented Interfaces:
Writeable,org.elasticsearch.core.RefCounted,TaskAwareRequest,TransportRequest
public class MountSearchableSnapshotRequest
extends MasterNodeRequest<MountSearchableSnapshotRequest>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnumerates the different ways that nodes can use their local storage to accelerate searches of a snapshot.Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ConstructingObjectParser<MountSearchableSnapshotRequest, RestRequest> Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionMountSearchableSnapshotRequest(org.elasticsearch.core.TimeValue masterNodeTimeout, String mountedIndexName, String repositoryName, String snapshotName, String snapshotIndexName, Settings indexSettings, String[] ignoreIndexSettings, boolean waitForCompletion, MountSearchableSnapshotRequest.Storage storage) Constructs a new mount searchable snapshot request, restoring an index with the settings needed to make it a searchable snapshot. -
Method Summary
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, setParentTask
-
Field Details
-
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<MountSearchableSnapshotRequest,RestRequest> PARSER
-
-
Constructor Details
-
MountSearchableSnapshotRequest
public MountSearchableSnapshotRequest(org.elasticsearch.core.TimeValue masterNodeTimeout, String mountedIndexName, String repositoryName, String snapshotName, String snapshotIndexName, Settings indexSettings, String[] ignoreIndexSettings, boolean waitForCompletion, MountSearchableSnapshotRequest.Storage storage) Constructs a new mount searchable snapshot request, restoring an index with the settings needed to make it a searchable snapshot. -
MountSearchableSnapshotRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classMasterNodeRequest<MountSearchableSnapshotRequest>- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
mountedIndexName
- Returns:
- the name of the index that will be created
-
repositoryName
- Returns:
- the name of the repository
-
snapshotName
- Returns:
- the name of the snapshot.
-
snapshotIndexName
- Returns:
- the name of the index contained in the snapshot
-
waitForCompletion
public boolean waitForCompletion()- Returns:
- true if the operation will wait for completion
-
indexSettings
- Returns:
- settings that should be added to the index when it is mounted
-
ignoreIndexSettings
- Returns:
- the names of settings that should be removed from the index when it is mounted
-
storage
- Returns:
- how nodes will use their local storage to accelerate searches of this snapshot
-
getDescription
-
equals
-
hashCode
public int hashCode() -
toString
- Overrides:
toStringin classAbstractTransportRequest
-