Package co.elastic.clients.elasticsearch._core

Class MgetRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch._core.MgetRequest.Builder
All Implemented Interfaces:
ObjectBuilder<MgetRequest>
Enclosing class:
MgetRequest
public static class MgetRequest.Builder
extends java.lang.Object
implements ObjectBuilder<MgetRequest>
Builder for MgetRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public MgetRequest.Builder index​(@Nullable java.lang.String value)
      The name of the index

      API name: index

    • type

      public MgetRequest.Builder type​(@Nullable java.lang.String value)
      The type of the document

      API name: type

    • preference

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

      API name: preference

    • realtime

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

      API name: realtime

    • refresh

      public MgetRequest.Builder refresh​(@Nullable java.lang.Boolean value)
      Refresh the shard containing the document before performing the operation

      API name: refresh

    • routing

      public MgetRequest.Builder routing​(@Nullable java.lang.String value)
      Specific routing value

      API name: routing

    • source

      public MgetRequest.Builder source​(@Nullable jakarta.json.JsonValue value)
      True or false to return the _source field or not, or a list of fields to return

      API name: _source

    • sourceExcludes

      public MgetRequest.Builder sourceExcludes​(@Nullable java.util.List<java.lang.String> value)
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

    • sourceExcludes

      public MgetRequest.Builder sourceExcludes​(java.lang.String... value)
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

    • addSourceExcludes

      public MgetRequest.Builder addSourceExcludes​(java.lang.String value)
      Add a value to sourceExcludes(List), creating the list if needed.

    • sourceIncludes

      public MgetRequest.Builder sourceIncludes​(@Nullable java.util.List<java.lang.String> value)
      A list of fields to extract and return from the _source field

      API name: _source_includes

    • sourceIncludes

      public MgetRequest.Builder sourceIncludes​(java.lang.String... value)
      A list of fields to extract and return from the _source field

      API name: _source_includes

    • addSourceIncludes

      public MgetRequest.Builder addSourceIncludes​(java.lang.String value)
      Add a value to sourceIncludes(List), creating the list if needed.

    • storedFields

      public MgetRequest.Builder storedFields​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of stored fields to return in the response

      API name: stored_fields

    • storedFields

      public MgetRequest.Builder storedFields​(java.lang.String... value)
      A comma-separated list of stored fields to return in the response

      API name: stored_fields

    • addStoredFields

      public MgetRequest.Builder addStoredFields​(java.lang.String value)
      Add a value to storedFields(List), creating the list if needed.

    • docs

      public MgetRequest.Builder docs​(@Nullable java.util.List<Operation> value)
      API name: docs

    • docs

      public MgetRequest.Builder docs​(Operation... value)
      API name: docs

    • addDocs

      public MgetRequest.Builder addDocs​(Operation value)
      Add a value to docs(List), creating the list if needed.

    • docs

      public MgetRequest.Builder docs​(java.util.function.Function<Operation.Builder,​ObjectBuilder<Operation>> fn)
      Set docs(List) to a singleton list.

    • addDocs

      public MgetRequest.Builder addDocs​(java.util.function.Function<Operation.Builder,​ObjectBuilder<Operation>> fn)
      Add a value to docs(List), creating the list if needed.

    • ids

      public MgetRequest.Builder ids​(@Nullable java.util.List<java.lang.String> value)
      API name: ids

    • ids

      public MgetRequest.Builder ids​(java.lang.String... value)
      API name: ids

    • addIds

      public MgetRequest.Builder addIds​(java.lang.String value)
      Add a value to ids(List), creating the list if needed.

    • build

      public MgetRequest build()
      Builds a MgetRequest.
      Specified by:
      build in interface ObjectBuilder<MgetRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.