Package co.elastic.clients.elasticsearch.core

Class ExistsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.ExistsRequest
public class ExistsRequest extends RequestBase
Returns information about whether a document exists in an index.
See Also:

  • Field Details

  • Method Details

    • of

      public static ExistsRequest of(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> 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 List<String> sourceExcludes()
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

    • sourceIncludes

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

      API name: _source_includes

    • id

      public final String id()
      Required - The document ID

      API name: id

    • index

      public final String index()
      Required - The name of the index

      API name: index

    • preference

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

      API name: preference

    • realtime

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

      API name: realtime

    • refresh

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

      API name: refresh

    • routing

      @Nullable public final String routing()
      Specific routing value

      API name: routing

    • storedFields

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

      API name: stored_fields

    • type

      @Nullable public final String type()
      The type of the document (use _all to fetch the first document matching the ID across all types)

      API name: type

    • version

      @Nullable public final Long version()
      Explicit version number for concurrency control

      API name: version

    • versionType

      @Nullable public final VersionType versionType()
      Specific version type

      API name: version_type