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, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class FieldCapabilitiesResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.ToXContentObject
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.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    FieldCapabilitiesResponse​(java.lang.String[] indices, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> responseMap)  
    FieldCapabilitiesResponse​(java.lang.String[] indices, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> responseMap, java.util.List<FieldCapabilitiesFailure> failures)  
    FieldCapabilitiesResponse​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static FieldCapabilitiesResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> get()
    Get the field capabilities map.
    java.lang.String[] getFailedIndices()
    Get the concrete list of indices that failed
    java.util.List<FieldCapabilitiesFailure> getFailures()
    Get possible request failures keyed by index name
    java.util.Map<java.lang.String,​FieldCapabilities> getField​(java.lang.String field)
    Get the field capabilities per type for the provided field.
    java.lang.String[] getIndices()
    Get the concrete list of indices that were requested and returned a response.
    int hashCode()  
    boolean isMetadataField​(java.lang.String field)
    Returns true if the provided field is a metadata field.
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, 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.ToXContentObject

    isFragment

  • Constructor Details

    • FieldCapabilitiesResponse

      public FieldCapabilitiesResponse​(java.lang.String[] indices, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> responseMap, java.util.List<FieldCapabilitiesFailure> failures)

    • FieldCapabilitiesResponse

      public FieldCapabilitiesResponse​(java.lang.String[] indices, java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> responseMap)

    • FieldCapabilitiesResponse

      public FieldCapabilitiesResponse​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • getIndices

      public java.lang.String[] getIndices()
      Get the concrete list of indices that were requested and returned a response.

    • getFailedIndices

      public java.lang.String[] getFailedIndices()
      Get the concrete list of indices that failed

    • get

      public java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​FieldCapabilities>> get()
      Get the field capabilities map.

    • getFailures

      public java.util.List<FieldCapabilitiesFailure> getFailures()
      Get possible request failures keyed by index name

    • getField

      public java.util.Map<java.lang.String,​FieldCapabilities> getField​(java.lang.String field)
      Get the field capabilities per type for the provided field.

    • isMetadataField

      public boolean isMetadataField​(java.lang.String field)
      Returns true if the provided field is a metadata field.

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static FieldCapabilitiesResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • 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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object