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.LegacyActionRequest
org.elasticsearch.action.search.OpenPointInTimeRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest
public final class OpenPointInTimeRequest
extends LegacyActionRequest
implements IndicesRequest.Replaceable
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanallowPartialSearchResults(boolean allowPartialSearchResults) booleanDetermines whether the request can contain indices on a remote cluster.Returns the task object that should be used to keep track of the processing of the request.booleanReturns optional description of the request to be displayed by the task managerinthashCode()booleanDetermines whether the request should be applied to data streams.voidindexFilter(QueryBuilder indexFilter) String[]indices()Returns the array of indices that the action relates toSets the indices that the action relates to.Returns the indices options used to resolve indices.indicesOptions(IndicesOptions indicesOptions) Set keep alive for the point in timeintSimilar toSearchRequest.getMaxConcurrentShardRequests(), this returns the number of shard requests that should be executed concurrently on a single node .voidmaxConcurrentShardRequests(int maxConcurrentShardRequests) Similar toSearchRequest.setMaxConcurrentShardRequests(int), this sets the number of shard requests that should be executed concurrently on a single node.preference(String preference) routing()toString()validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
OpenPointInTimeRequest
-
OpenPointInTimeRequest
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
validate
- Specified by:
validatein classActionRequest
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indices
Description copied from interface:IndicesRequest.ReplaceableSets the indices that the action relates to.- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
indicesOptions
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
indicesOptions
-
keepAlive
-
keepAlive
Set keep alive for the point in time -
routing
-
routing
-
preference
-
preference
-
maxConcurrentShardRequests
public int maxConcurrentShardRequests()Similar toSearchRequest.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 is5 -
maxConcurrentShardRequests
public void maxConcurrentShardRequests(int maxConcurrentShardRequests) Similar toSearchRequest.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
-
indexFilter
-
allowsRemoteIndices
public boolean allowsRemoteIndices()Description copied from interface:IndicesRequest.ReplaceableDetermines whether the request can contain indices on a remote cluster. NOTE in theory this method can belong to theIndicesRequestinterface because whether a request allowing remote indices has no inherent relationship to whether it isIndicesRequest.Replaceableor 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:
allowsRemoteIndicesin interfaceIndicesRequest.Replaceable
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines whether the request should be applied to data streams. Whenfalse, none of the names or wildcard expressions inIndicesRequest.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:
includeDataStreamsin interfaceIndicesRequest
-
allowPartialSearchResults
public boolean allowPartialSearchResults() -
allowPartialSearchResults
-
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager- Specified by:
getDescriptionin interfaceTaskAwareRequest
-
toString
- Overrides:
toStringin classTransportRequest
-
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.- Specified by:
createTaskin interfaceTaskAwareRequest
-
equals
-
hashCode
public int hashCode()
-