Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class OpenPointInTimeRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.search.OpenPointInTimeRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public final class OpenPointInTimeRequest
extends ActionRequest
implements IndicesRequest.Replaceable

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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 IndicesOptions	DEFAULT_INDICES_OPTIONS

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
OpenPointInTimeRequest(String... indices)
OpenPointInTimeRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowsRemoteIndices()	Determines whether the request can contain indices on a remote cluster.
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	equals(Object o)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
QueryBuilder	indexFilter()
void	indexFilter(QueryBuilder indexFilter)
String[]	indices()	Returns the array of indices that the action relates to
OpenPointInTimeRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
OpenPointInTimeRequest	indicesOptions(IndicesOptions indicesOptions)
TimeValue	keepAlive()
OpenPointInTimeRequest	keepAlive(TimeValue keepAlive)	Set keep alive for the point in time
int	maxConcurrentShardRequests()	Similar to SearchRequest.getMaxConcurrentShardRequests(), this returns the number of shard requests that should be executed concurrently on a single node .
void	maxConcurrentShardRequests(int maxConcurrentShardRequests)	Similar to SearchRequest.setMaxConcurrentShardRequests(int), this sets the number of shard requests that should be executed concurrently on a single node.
String	preference()
OpenPointInTimeRequest	preference(String preference)
String	routing()
OpenPointInTimeRequest	routing(String routing)
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

OpenPointInTimeRequest

public OpenPointInTimeRequest(String... indices)

OpenPointInTimeRequest

public OpenPointInTimeRequest(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public OpenPointInTimeRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public OpenPointInTimeRequest indicesOptions(IndicesOptions indicesOptions)

keepAlive

public TimeValue keepAlive()

keepAlive

public OpenPointInTimeRequest keepAlive(TimeValue keepAlive)

Set keep alive for the point in time

routing

public String routing()

routing

public OpenPointInTimeRequest routing(String routing)

preference

public String preference()

preference

public OpenPointInTimeRequest preference(String preference)

maxConcurrentShardRequests

public int maxConcurrentShardRequests()

Similar to SearchRequest.getMaxConcurrentShardRequests(), this returns the number of shard requests that should be executed concurrently on a single node . This value should be used as a protection mechanism to reduce the number of shard requests fired per open point-in-time request. The default is 5

maxConcurrentShardRequests

public void maxConcurrentShardRequests(int maxConcurrentShardRequests)

Similar to SearchRequest.setMaxConcurrentShardRequests(int), this sets the number of shard requests that should be executed concurrently on a single node. This value should be used as a protection mechanism to reduce the number of shard requests fired per open point-in-time request.

indexFilter

public void indexFilter(QueryBuilder indexFilter)

indexFilter

public QueryBuilder indexFilter()

allowsRemoteIndices

public boolean allowsRemoteIndices()

Description copied from interface: IndicesRequest.Replaceable

Determines whether the request can contain indices on a remote cluster. NOTE in theory this method can belong to the IndicesRequest interface because whether a request allowing remote indices has no inherent relationship to whether it is IndicesRequest.Replaceable or not. However, we don't have an existing request that is non-replaceable but allows remote indices. In addition, authorization code currently relies on the fact that non-replaceable requests do not allow remote indices. That said, it is possible to remove this constraint should the needs arise in the future. We just need proceed with extra caution.

Specified by:

allowsRemoteIndices in interface IndicesRequest.Replaceable

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

toString

public String toString()

Overrides:

toString in class TransportRequest

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

Specified by:

createTask in interface TaskAwareRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object