- All Implemented Interfaces:
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
Method SummaryModifier and TypeMethodDescription
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.Returns optional description of the request to be displayed by the task manager
booleanDetermines whether the request should be applied to data streams.
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.Set keep alive for the point in time
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
DEFAULT_INDICES_OPTIONSpublic static final IndicesOptions DEFAULT_INDICES_OPTIONS
writeToDescription copied from interface:
validatepublic ActionRequestValidationException validate()
indicespublic String indices()Returns the array of indices that the action relates to
indicesDescription copied from interface:
IndicesRequest.ReplaceableSets the indices that the action relates to.
indicesOptionspublic IndicesOptions indicesOptions()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.
keepAlivepublic TimeValue keepAlive()
keepAliveSet keep alive for the point in time
routingpublic String routing()
preferencepublic String preference()
allowsRemoteIndicespublic 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 the
IndicesRequestinterface because whether a request allowing remote indices has no inherent relationship to whether it is
IndicesRequest.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.
includeDataStreamspublic boolean includeDataStreams()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.
getDescriptionpublic String getDescription()Description copied from interface:
TaskAwareRequestReturns optional description of the request to be displayed by the task manager
createTaskpublic 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.