Module org.elasticsearch.server
Class FieldCapabilitiesRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest,ToXContent,ToXContentObject
public final class FieldCapabilitiesRequest
extends LegacyActionRequest
implements IndicesRequest.Replaceable, ToXContentObject
-
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.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanDetermines 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.booleanString[]fields()The list of field names to retrieveString[]filters()Returns optional description of the request to be displayed by the task managerinthashCode()booleanDetermines whether the request should be applied to data streams.booleanincludeEmptyFields(boolean includeEmptyFields) booleanincludeUnmapped(boolean includeUnmapped) indexFilter(QueryBuilder indexFilter) Allows to filter indices if the providedQueryBuilderrewrites to `match_none` on every shard.String[]indices()Returns the array of indices that the action relates toThe list of indices to lookupReturns the indices options used to resolve indices.indicesOptions(IndicesOptions indicesOptions) booleanReturnstrueiff the results should be merged.runtimeFields(Map<String, Object> runtimeFieldsSection) Allows adding search runtime fields if provided.voidsetMergeResults(boolean mergeResults) If set totruethe response will contain only a merged view of the per index field capabilities.toXContent(XContentBuilder builder, ToXContent.Params params) String[]types()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, setRequestId, toStringMethods 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
setParentTaskMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
FieldCapabilitiesRequest
- Throws:
IOException
-
FieldCapabilitiesRequest
public FieldCapabilitiesRequest()
-
-
Method Details
-
isMergeResults
public boolean isMergeResults()Returnstrueiff the results should be merged.Note that when using the high-level REST client, results are always merged (this flag is always considered 'true').
-
setMergeResults
public void setMergeResults(boolean mergeResults) If set totruethe response will contain only a merged view of the per index field capabilities. Otherwise only unmerged per index field capabilities are returned.Note that when using the high-level REST client, results are always merged (this flag is always considered 'true').
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classActionRequest- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
fields
The list of field names to retrieve -
fields
-
filters
-
filters
-
types
-
types
-
indices
The list of indices to lookup- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
indicesOptions
-
includeUnmapped
-
includeEmptyFields
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
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
-
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
-
includeUnmapped
public boolean includeUnmapped() -
includeEmptyFields
public boolean includeEmptyFields() -
indexFilter
Allows to filter indices if the providedQueryBuilderrewrites to `match_none` on every shard. -
indexFilter
-
runtimeFields
Allows adding search runtime fields if provided. -
runtimeFields
-
validate
- Specified by:
validatein classActionRequest
-
equals
-
hashCode
public int hashCode() -
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager- Specified by:
getDescriptionin interfaceTaskAwareRequest
-
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
-