Package org.elasticsearch.action.admin.indices.mapping.get

Class GetFieldMappingsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsRequest
All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest
public class GetFieldMappingsRequest
extends ActionRequest
implements IndicesRequest.Replaceable
Request the mappings of specific fields Note: there is a new class with the same name for the Java HLRC that uses a typeless format. Any changes done to this class should go to that client class as well.

  • Field Details

    • local

      protected boolean local

  • Constructor Details

    • GetFieldMappingsRequest

      public GetFieldMappingsRequest()

    • GetFieldMappingsRequest

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

  • Method Details

    • local

      public GetFieldMappingsRequest local​(boolean local)
      Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices.

    • local

      public boolean local()

    • indices

      public GetFieldMappingsRequest indices​(java.lang.String... indices)
      Description copied from interface: IndicesRequest.Replaceable
      Sets the indices that the action relates to.
      Specified by:
      indices in interface IndicesRequest.Replaceable

    • types

      public GetFieldMappingsRequest types​(java.lang.String... types)

    • indicesOptions

      public GetFieldMappingsRequest indicesOptions​(IndicesOptions indicesOptions)

    • 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

    • types

      public java.lang.String[] types()

    • 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

    • fields

      public GetFieldMappingsRequest fields​(java.lang.String... fields)
      Parameters:
      fields - a list of fields to retrieve the mapping for

    • fields

      public java.lang.String[] fields()

    • includeDefaults

      public boolean includeDefaults()

    • includeDefaults

      public GetFieldMappingsRequest includeDefaults​(boolean includeDefaults)
      Indicates whether default mapping settings should be returned

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • 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