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, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, TaskAwareRequest
public final class FieldCapabilitiesRequest
extends ActionRequest
implements IndicesRequest.Replaceable, org.elasticsearch.common.xcontent.ToXContentObject

  • Field Details

  • Constructor Details

    • FieldCapabilitiesRequest

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

    • FieldCapabilitiesRequest

      public FieldCapabilitiesRequest()

  • Method Details

    • 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
      Overrides:
      writeTo in class ActionRequest
      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

    • 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

    • 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()

    • 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​(java.util.Map<java.lang.String,​java.lang.Object> runtimeFieldsSection)
      Allows adding search runtime fields if provided.

    • runtimeFields

      public java.util.Map<java.lang.String,​java.lang.Object> runtimeFields()

    • 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