Package co.elastic.clients.elasticsearch.core

Class ExistsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExistsRequest.Builder>
co.elastic.clients.elasticsearch.core.ExistsRequest.Builder
All Implemented Interfaces:
WithJson<ExistsRequest.Builder>, ObjectBuilder<ExistsRequest>
Enclosing class:
ExistsRequest
public static class ExistsRequest.Builder extends RequestBase.AbstractBuilder<ExistsRequest.Builder> implements ObjectBuilder<ExistsRequest>
Builder for ExistsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • source

      public final ExistsRequest.Builder source(@Nullable SourceConfigParam value)
      Indicates whether to return the _source field (true or false) or lists the fields to return.

      API name: _source

    • source

      public final ExistsRequest.Builder source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)
      Indicates whether to return the _source field (true or false) or lists the fields to return.

      API name: _source

    • sourceExcludes

      public final ExistsRequest.Builder sourceExcludes(List<String> list)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds all elements of list to sourceExcludes.

    • sourceExcludes

      public final ExistsRequest.Builder sourceExcludes(String value, String... values)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds one or more values to sourceExcludes.

    • sourceIncludes

      public final ExistsRequest.Builder sourceIncludes(List<String> list)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds all elements of list to sourceIncludes.

    • sourceIncludes

      public final ExistsRequest.Builder sourceIncludes(String value, String... values)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds one or more values to sourceIncludes.

    • id

      public final ExistsRequest.Builder id(String value)
      Required - A unique document identifier.

      API name: id

    • index

      public final ExistsRequest.Builder index(String value)
      Required - A comma-separated list of data streams, indices, and aliases. It supports wildcards (*).

      API name: index

    • preference

      public final ExistsRequest.Builder preference(@Nullable String value)
      The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.

      If it is set to _local, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.

      API name: preference

    • realtime

      public final ExistsRequest.Builder realtime(@Nullable Boolean value)
      If true, the request is real-time as opposed to near-real-time.

      API name: realtime

    • refresh

      public final ExistsRequest.Builder refresh(@Nullable Boolean value)
      If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).

      API name: refresh

    • routing

      public final ExistsRequest.Builder routing(@Nullable String value)
      A custom value used to route operations to a specific shard.

      API name: routing

    • storedFields

      public final ExistsRequest.Builder storedFields(List<String> list)
      A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false.

      API name: stored_fields

      Adds all elements of list to storedFields.

    • storedFields

      public final ExistsRequest.Builder storedFields(String value, String... values)
      A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false.

      API name: stored_fields

      Adds one or more values to storedFields.

    • version

      public final ExistsRequest.Builder version(@Nullable Long value)
      Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

      API name: version

    • versionType

      public final ExistsRequest.Builder versionType(@Nullable VersionType value)
      The version type.

      API name: version_type

    • self

      protected ExistsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<ExistsRequest.Builder>

    • build

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