Module org.elasticsearch.server

Package org.elasticsearch.action.fieldcaps

Class FieldCapabilitiesResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.fieldcaps.FieldCapabilitiesResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class FieldCapabilitiesResponse
extends ActionResponse
implements ChunkedToXContentObject

Response for FieldCapabilitiesRequest requests.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
FieldCapabilitiesResponse(String[] indices, Map<String,Map<String,FieldCapabilities>> responseMap)
FieldCapabilitiesResponse(String[] indices, Map<String,Map<String,FieldCapabilities>> responseMap, List<FieldCapabilitiesFailure> failures)
FieldCapabilitiesResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static FieldCapabilitiesResponse	fromXContent(XContentParser parser)
Map<String,Map<String,FieldCapabilities>>	get()	Get the field capabilities map.
int	getFailedIndicesCount()	Get the concrete list of indices that failed
List<FieldCapabilitiesFailure>	getFailures()	Get possible request failures keyed by index name
Map<String,FieldCapabilities>	getField(String field)	Get the field capabilities per type for the provided field.
String[]	getIndices()	Get the concrete list of indices that were requested and returned a response.
int	hashCode()
boolean	isMetadataField(String field)	Returns true if the provided field is a metadata field.
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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.common.xcontent.ChunkedToXContent

toXContentChunkedV7

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

FieldCapabilitiesResponse

public FieldCapabilitiesResponse(String[] indices,
 Map<String,Map<String,FieldCapabilities>> responseMap,
 List<FieldCapabilitiesFailure> failures)

FieldCapabilitiesResponse

public FieldCapabilitiesResponse(String[] indices,
 Map<String,Map<String,FieldCapabilities>> responseMap)

FieldCapabilitiesResponse

public FieldCapabilitiesResponse(StreamInput in)
                          throws IOException

Throws:

IOException

Method Details

getIndices

public String[] getIndices()

Get the concrete list of indices that were requested and returned a response.

getFailedIndicesCount

public int getFailedIndicesCount()

Get the concrete list of indices that failed

get

public Map<String,Map<String,FieldCapabilities>> get()

Get the field capabilities map.

getFailures

public List<FieldCapabilitiesFailure> getFailures()

Get possible request failures keyed by index name

getField

public Map<String,FieldCapabilities> getField(String field)

Get the field capabilities per type for the provided field.

isMetadataField

public boolean isMetadataField(String field)

Returns true if the provided field is a metadata field.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

fromXContent

public static FieldCapabilitiesResponse fromXContent(XContentParser parser)
                                              throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object