Module org.elasticsearch.server
Class ResolveClusterActionRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.admin.indices.resolve.ResolveClusterActionRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest,TransportRequest
public class ResolveClusterActionRequest
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
ConstructorsConstructorDescriptionResolveClusterActionRequest(String[] names) ResolveClusterActionRequest(String[] names, IndicesOptions indicesOptions, boolean clusterInfoOnly, boolean queryingCluster) -
Method Summary
Modifier and TypeMethodDescriptionbooleanDetermines whether the request can contain indices on a remote cluster.booleanReturns the task object that should be used to keep track of the processing of the request.booleaninthashCode()booleanDetermines whether the request should be applied to data streams.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.protected IndicesRequestindicesOptions(IndicesOptions indicesOptions) booleanbooleanvoidsetTimeout(TimeValue timeout) 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.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, getDescription, setParentTask
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
TRANSPORT_VERSION_ERROR_MESSAGE_PREFIX
- See Also:
-
-
Constructor Details
-
ResolveClusterActionRequest
-
ResolveClusterActionRequest
public ResolveClusterActionRequest(String[] names, IndicesOptions indicesOptions, boolean clusterInfoOnly, boolean queryingCluster) -
ResolveClusterActionRequest
- 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
-
equals
-
hashCode
public int hashCode() -
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
getTimeout
-
clusterInfoOnly
public boolean clusterInfoOnly() -
queryingCluster
public boolean queryingCluster() -
isLocalIndicesRequested
public boolean isLocalIndicesRequested() -
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
-
indices
Description copied from interface:IndicesRequest.ReplaceableSets the indices that the action relates to.- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
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
-
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
-
setTimeout
-
toString
- Overrides:
toStringin classAbstractTransportRequest
-