Class MgetRequest

All Implemented Interfaces:

public class MgetRequest
extends RequestBase
implements JsonpSerializable
Allows to get multiple documents in one request.
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static MgetRequest of​(java.util.function.Function<MgetRequest.Builder,​ObjectBuilder<MgetRequest>> fn)
    • source

      @Nullable public final SourceConfigParam source()
      True or false to return the _source field or not, or a list of fields to return

      API name: _source

    • sourceExcludes

      public final java.util.List<java.lang.String> sourceExcludes()
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

    • sourceIncludes

      public final java.util.List<java.lang.String> sourceIncludes()
      A list of fields to extract and return from the _source field

      API name: _source_includes

    • docs

      public final java.util.List<MultiGetOperation> docs()
      API name: docs
    • ids

      public final java.util.List<java.lang.String> ids()
      API name: ids
    • index

      @Nullable public final java.lang.String index()
      The name of the index

      API name: index

    • preference

      @Nullable public final java.lang.String preference()
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • realtime

      @Nullable public final java.lang.Boolean realtime()
      Specify whether to perform the operation in realtime or search mode

      API name: realtime

    • refresh

      @Nullable public final java.lang.Boolean refresh()
      Refresh the shard containing the document before performing the operation

      API name: refresh

    • routing

      @Nullable public final java.lang.String routing()
      Specific routing value

      API name: routing

    • storedFields

      public final java.util.List<java.lang.String> storedFields()
      A comma-separated list of stored fields to return in the response

      API name: stored_fields

    • type

      @Nullable public final java.lang.String type()
      The type of the document

      API name: type

    • serialize

      public void serialize​( generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable
    • serializeInternal

      protected void serializeInternal​( generator, JsonpMapper mapper)
    • setupMgetRequestDeserializer

      protected static void setupMgetRequestDeserializer​(ObjectDeserializer<MgetRequest.Builder> op)
    • createMgetEndpoint

      public static <TDocument> Endpoint<MgetRequest,​MgetResponse<TDocument>,​ErrorResponse> createMgetEndpoint​(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "mget" endpoint.