Package co.elastic.clients.elasticsearch._core

Class ExistsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.ExistsRequest
All Implemented Interfaces:
ElasticsearchCommonRequest
public final class ExistsRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  ExistsRequest.Builder
    Builder for ExistsRequest.

    Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

    RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Endpoint<ExistsRequest,​BooleanResponse,​ElasticsearchError> ENDPOINT
    Endpoint "exists".

  • Constructor Summary

    Constructors
    Constructor Description
    ExistsRequest​(ExistsRequest.Builder builder)  
    ExistsRequest​(java.util.function.Function<ExistsRequest.Builder,​ExistsRequest.Builder> fn)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String id()
    Required - The document ID
    java.lang.String index()
    Required - The name of the index
    java.lang.String preference()
    Specify the node or shard the operation should be performed on (default: random)
    java.lang.Boolean realtime()
    Specify whether to perform the operation in realtime or search mode
    java.lang.Boolean refresh()
    Refresh the shard containing the document before performing the operation
    java.lang.String routing()
    Specific routing value
    jakarta.json.JsonValue source()
    True or false to return the _source field or not, or a list of fields to return
    java.util.List<java.lang.String> sourceExcludes()
    A list of fields to exclude from the returned _source field
    java.util.List<java.lang.String> sourceIncludes()
    A list of fields to extract and return from the _source field
    java.util.List<java.lang.String> storedFields()
    A comma-separated list of stored fields to return in the response
    java.lang.String type()
    The type of the document (use _all to fetch the first document matching the ID across all types)
    java.lang.Long version()
    Explicit version number for concurrency control
    VersionType versionType()
    Specific version type

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • id

      public java.lang.String id()
      Required - The document ID

      API name: id

    • index

      public java.lang.String index()
      Required - The name of the index

      API name: index

    • type

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

      API name: type

    • preference

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

      API name: preference

    • realtime

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

      API name: realtime

    • refresh

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

      API name: refresh

    • routing

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

      API name: routing

    • source

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

      API name: _source

    • sourceExcludes

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

      API name: _source_excludes

    • sourceIncludes

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

      API name: _source_includes

    • storedFields

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

      API name: stored_fields

    • version

      @Nullable public java.lang.Long version()
      Explicit version number for concurrency control

      API name: version

    • versionType

      @Nullable public VersionType versionType()
      Specific version type

      API name: version_type