Module org.elasticsearch.server

Package org.elasticsearch.action.fieldcaps

Class FieldCapabilitiesRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

public final class FieldCapabilitiesRequest
extends UntypedActionRequest
implements IndicesRequest.Replaceable, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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

Modifier and Type	Field	Description
static final IndicesOptions	DEFAULT_INDICES_OPTIONS
static final String	NAME

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldCapabilitiesRequest()
FieldCapabilitiesRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowsRemoteIndices()	Determines whether the request can contain indices on a remote cluster.
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	equals(Object o)
String[]	fields()
FieldCapabilitiesRequest	fields(String... fields)	The list of field names to retrieve
String[]	filters()
FieldCapabilitiesRequest	filters(String... filters)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
boolean	includeEmptyFields()
FieldCapabilitiesRequest	includeEmptyFields(boolean includeEmptyFields)
boolean	includeUnmapped()
FieldCapabilitiesRequest	includeUnmapped(boolean includeUnmapped)
QueryBuilder	indexFilter()
FieldCapabilitiesRequest	indexFilter(QueryBuilder indexFilter)	Allows to filter indices if the provided QueryBuilder rewrites to `match_none` on every shard.
String[]	indices()	Returns the array of indices that the action relates to
FieldCapabilitiesRequest	indices(String... indices)	The list of indices to lookup
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
FieldCapabilitiesRequest	indicesOptions(IndicesOptions indicesOptions)
boolean	isMergeResults()	Returns true iff the results should be merged.
Map<String,Object>	runtimeFields()
FieldCapabilitiesRequest	runtimeFields(Map<String,Object> runtimeFieldsSection)	Allows adding search runtime fields if provided.
void	setMergeResults(boolean mergeResults)	If set to true the response will contain only a merged view of the per index field capabilities.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String[]	types()
FieldCapabilitiesRequest	types(String... types)
ActionRequestValidationException	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, getRequestId, setParentTask, setRequestId, 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.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

FieldCapabilitiesRequest

public FieldCapabilitiesRequest(StreamInput in)
                         throws IOException

Throws:

IOException

FieldCapabilitiesRequest

public FieldCapabilitiesRequest()

Method Details

isMergeResults

public boolean isMergeResults()

Returns true iff 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 to true the 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

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fields

public FieldCapabilitiesRequest fields(String... fields)

The list of field names to retrieve

fields

public String[] fields()

filters

public FieldCapabilitiesRequest filters(String... filters)

filters

public String[] filters()

types

public FieldCapabilitiesRequest types(String... types)

types

public String[] types()

indices

public FieldCapabilitiesRequest indices(String... indices)

The list of indices to lookup

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public FieldCapabilitiesRequest indicesOptions(IndicesOptions indicesOptions)

includeUnmapped

public FieldCapabilitiesRequest includeUnmapped(boolean includeUnmapped)

includeEmptyFields

public FieldCapabilitiesRequest includeEmptyFields(boolean includeEmptyFields)

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions 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 interface IndicesRequest

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 the IndicesRequest interface because whether a request allowing remote indices has no inherent relationship to whether it is IndicesRequest.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 interface IndicesRequest.Replaceable

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

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.

Specified by:

includeDataStreams in interface IndicesRequest

includeUnmapped

public boolean includeUnmapped()

includeEmptyFields

public boolean includeEmptyFields()

indexFilter

public FieldCapabilitiesRequest indexFilter(QueryBuilder indexFilter)

Allows to filter indices if the provided QueryBuilder rewrites to `match_none` on every shard.

indexFilter

public QueryBuilder indexFilter()

runtimeFields

public FieldCapabilitiesRequest runtimeFields(Map<String,Object> runtimeFieldsSection)

Allows adding search runtime fields if provided.

runtimeFields

public Map<String,Object> runtimeFields()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

Specified by:

createTask in interface TaskAwareRequest