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.fieldcaps.FieldCapabilitiesRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable, Writeable, TaskAwareRequest

public final class FieldCapabilitiesRequest
extends ActionRequest
implements IndicesRequest.Replaceable

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.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	FIELDS_FIELD
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor	Description
FieldCapabilitiesRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String[]	fields()
FieldCapabilitiesRequest	fields(java.lang.String... fields)	The list of field names to retrieve
int	hashCode()
boolean	includeUnmapped()
FieldCapabilitiesRequest	includeUnmapped(boolean includeUnmapped)
java.lang.String[]	indices()	Returns the array of indices that the action relates to
FieldCapabilitiesRequest	indices(java.lang.String... indices)	The list of indices to lookup
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
FieldCapabilitiesRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Detail

FIELDS_FIELD

public static final ParseField FIELDS_FIELD

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

FieldCapabilitiesRequest

public FieldCapabilitiesRequest()

Method Detail

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException

fields

public FieldCapabilitiesRequest fields(java.lang.String... fields)

The list of field names to retrieve

fields

public java.lang.String[] fields()

indices

public FieldCapabilitiesRequest indices(java.lang.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)

indices

public java.lang.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

includeUnmapped

public boolean includeUnmapped()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object