Package org.opensearch.client.opensearch.indices

Class ValidateQueryRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.ValidateQueryRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ValidateQueryRequest.Builder,ValidateQueryRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class ValidateQueryRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<ValidateQueryRequest.Builder,ValidateQueryRequest>
Allows a user to validate a potentially expensive query without executing it.

  • Field Details

  • Method Details

    • of

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

    • allShards

      @Nullable public final Boolean allShards()
      If true, the validation is executed on all shards instead of one random shard per index.

      API name: all_shards

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • analyzeWildcard

      @Nullable public final Boolean analyzeWildcard()
      If true, wildcard and prefix queries are analyzed.

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

      API name: analyzer

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      The default operator for query string query: AND or OR.

      API name: default_operator

    • df

      @Nullable public final String df()
      Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.

      API name: df

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

    • explain

      @Nullable public final Boolean explain()
      If true, the response returns detailed information if an error has occurred.

      API name: explain

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.

      API name: index

    • lenient

      @Nullable public final Boolean lenient()
      If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

      API name: lenient

    • q

      @Nullable public final String q()
      Query in the Lucene query string syntax.

      API name: q

    • query

      @Nullable public final Query query()
      API name: query

    • rewrite

      @Nullable public final Boolean rewrite()
      If true, returns a more detailed explanation showing the actual Lucene query that will be executed.

      API name: rewrite

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public ValidateQueryRequest.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<ValidateQueryRequest.Builder,ValidateQueryRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ValidateQueryRequest.Builder builder()

    • setupValidateQueryRequestDeserializer

      protected static void setupValidateQueryRequestDeserializer(ObjectDeserializer<ValidateQueryRequest.Builder> op)

    • 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