Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.searchablesnapshots

Class MountSearchableSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<MountSearchableSnapshotRequest>

org.elasticsearch.xpack.core.searchablesnapshots.MountSearchableSnapshotRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public class MountSearchableSnapshotRequest
extends MasterNodeRequest<MountSearchableSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MountSearchableSnapshotRequest.Storage	Enumerates 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

Fields

Modifier and Type	Field	Description
static final ConstructingObjectParser<MountSearchableSnapshotRequest,RestRequest>	PARSER

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
MountSearchableSnapshotRequest(StreamInput in)
MountSearchableSnapshotRequest(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

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()
int	hashCode()
String[]	ignoreIndexSettings()
Settings	indexSettings()
String	mountedIndexName()
String	repositoryName()
String	snapshotIndexName()
String	snapshotName()
MountSearchableSnapshotRequest.Storage	storage()
String	toString()
ActionRequestValidationException	validate()
boolean	waitForCompletion()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterTerm

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, setParentTask

Field Details

PARSER

public static final ConstructingObjectParser<MountSearchableSnapshotRequest,RestRequest> PARSER

Constructor Details

MountSearchableSnapshotRequest

public MountSearchableSnapshotRequest(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

public MountSearchableSnapshotRequest(StreamInput in)
                               throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeRequest<MountSearchableSnapshotRequest>

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

mountedIndexName

public String mountedIndexName()

Returns:

the name of the index that will be created

repositoryName

public String repositoryName()

Returns:

the name of the repository

snapshotName

public String snapshotName()

Returns:

the name of the snapshot.

snapshotIndexName

public String 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

public Settings indexSettings()

Returns:

settings that should be added to the index when it is mounted

ignoreIndexSettings

public String[] ignoreIndexSettings()

Returns:

the names of settings that should be removed from the index when it is mounted

storage

public MountSearchableSnapshotRequest.Storage storage()

Returns:

how nodes will use their local storage to accelerate searches of this snapshot

getDescription

public String getDescription()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest