Package org.opensearch.client.opensearch.core

Class ExistsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.ExistsRequest
All Implemented Interfaces:
ToCopyableBuilder<ExistsRequest.Builder,ExistsRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class ExistsRequest extends RequestBase implements ToCopyableBuilder<ExistsRequest.Builder,ExistsRequest>
Returns information about whether a document exists in an index.

  • Field Details

  • Method Details

    • of

      public static ExistsRequest of(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)

    • id

      @Nonnull public final String id()
      Required - Identifier of the document.

      API name: id

    • index

      @Nonnull public final String index()
      Required - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).

      API name: index

    • preference

      @Nullable public final String preference()
      Specifies the node or shard the operation should be performed on. Random by default.

      API name: preference

    • realtime

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

      API name: realtime

    • refresh

      @Nullable public final Refresh refresh()
      If true, OpenSearch refreshes all shards involved in the delete by query after the request completes.

      API name: refresh

    • routing

      @Nonnull public final List<String> routing()
      Target the specified primary shard.

      API name: routing

    • 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

      @Nonnull public final List<String> sourceExcludes()
      A comma-separated list of source fields to exclude in the response.

      API name: _source_excludes

    • sourceIncludes

      @Nonnull public final List<String> sourceIncludes()
      A comma-separated list of source fields to include in the response.

      API name: _source_includes

    • storedFields

      @Nonnull public final List<String> storedFields()
      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

    • version

      @Nullable public final Long version()
      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

      @Nullable public final VersionType versionType()
      Specific version type: external, external_gte.

      API name: version_type

    • toBuilder

      @Nonnull public ExistsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExistsRequest.Builder,ExistsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ExistsRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object