Module org.elasticsearch.server
Class FieldCapabilitiesRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,RefCounted
,TaskAwareRequest
,ToXContent
,ToXContentObject
public final class FieldCapabilitiesRequest
extends ActionRequest
implements IndicesRequest.Replaceable, ToXContentObject
-
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.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines whether the request can contain indices on a remote cluster.boolean
String[]
fields()
The list of field names to retrieveString[]
filters()
Returns optional description of the request to be displayed by the task managerint
hashCode()
boolean
Determines whether the request should be applied to data streams.boolean
includeUnmapped
(boolean includeUnmapped) indexFilter
(QueryBuilder indexFilter) Allows to filter indices if the providedQueryBuilder
rewrites 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) runtimeFields
(Map<String, Object> runtimeFieldsSection) Allows adding search runtime fields if provided.toXContent
(XContentBuilder builder, ToXContent.Params params) String[]
types()
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, setParentTask, toString
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.tasks.TaskAwareRequest
createTask, setParentTask
Methods 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
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in 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:
indices
in interfaceIndicesRequest.Replaceable
-
indicesOptions
-
includeUnmapped
-
indices
Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
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 interfaceIndicesRequest
-
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 theIndicesRequest
interface because whether a request allowing remote indices has no inherent relationship to whether it isIndicesRequest.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 interfaceIndicesRequest.Replaceable
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines 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:
includeDataStreams
in interfaceIndicesRequest
-
includeUnmapped
public boolean includeUnmapped() -
indexFilter
Allows to filter indices if the providedQueryBuilder
rewrites to `match_none` on every shard. -
indexFilter
-
runtimeFields
Allows adding search runtime fields if provided. -
runtimeFields
-
validate
- Specified by:
validate
in classActionRequest
-
equals
-
hashCode
public int hashCode() -
getDescription
Description copied from interface:TaskAwareRequest
Returns optional description of the request to be displayed by the task manager- Specified by:
getDescription
in interfaceTaskAwareRequest
-