Module org.elasticsearch.server
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
Response for
FieldCapabilitiesRequest requests.-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ParseFieldstatic final ParseFieldstatic final ParseFieldFields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
EMPTYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionFieldCapabilitiesResponse(String[] indices, Map<String, Map<String, FieldCapabilities>> responseMap) FieldCapabilitiesResponse(String[] indices, Map<String, Map<String, FieldCapabilities>> responseMap, List<FieldCapabilitiesFailure> failures) FieldCapabilitiesResponse(List<FieldCapabilitiesIndexResponse> indexResponses, List<FieldCapabilitiesFailure> failures) -
Method Summary
Modifier and TypeMethodDescriptionbooleanget()Get the field capabilities map.intGet the concrete list of indices that failedGet possible request failures keyed by index nameGet the field capabilities per type for the providedfield.Returns the actual per-index field caps responsesString[]Get the concrete list of indices that were requested and returned a response.inthashCode()booleanisMetadataField(String field) Returnstrueif the provided field is a metadata field.toString()Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods 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.common.xcontent.ChunkedToXContent
toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Field Details
-
INDICES_FIELD
-
FIELDS_FIELD
-
FAILURES_FIELD
-
-
Constructor Details
-
FieldCapabilitiesResponse
public FieldCapabilitiesResponse(String[] indices, Map<String, Map<String, FieldCapabilities>> responseMap, List<FieldCapabilitiesFailure> failures) -
FieldCapabilitiesResponse
-
FieldCapabilitiesResponse
public FieldCapabilitiesResponse(List<FieldCapabilitiesIndexResponse> indexResponses, List<FieldCapabilitiesFailure> failures) -
FieldCapabilitiesResponse
- Throws:
IOException
-
-
Method Details
-
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
Get the field capabilities map. -
getFailures
Get possible request failures keyed by index name -
getIndexResponses
Returns the actual per-index field caps responses -
getField
Get the field capabilities per type for the providedfield. -
isMetadataField
Returnstrueif the provided field is a metadata field. -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. For best results, all chunks should beO(1)size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelperfor 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:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-
equals
-
hashCode
public int hashCode() -
toString
-