Package co.elastic.clients.elasticsearch.indices

Class ValidateQueryRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<ValidateQueryRequest.Builder>
co.elastic.clients.elasticsearch.indices.ValidateQueryRequest.Builder
All Implemented Interfaces:
WithJson<ValidateQueryRequest.Builder>, ObjectBuilder<ValidateQueryRequest>
Enclosing class:
ValidateQueryRequest
public static class ValidateQueryRequest.Builder
extends WithJsonObjectBuilderBase<ValidateQueryRequest.Builder>
implements ObjectBuilder<ValidateQueryRequest>
Builder for ValidateQueryRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allShards

      public final ValidateQueryRequest.Builder allShards​(@Nullable java.lang.Boolean value)
      Execute validation on all shards instead of one random shard per index

      API name: all_shards

    • allowNoIndices

      public final ValidateQueryRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • analyzeWildcard

      public final ValidateQueryRequest.Builder analyzeWildcard​(@Nullable java.lang.Boolean value)
      Specify whether wildcard and prefix queries should be analyzed (default: false)

      API name: analyze_wildcard

    • analyzer

      public final ValidateQueryRequest.Builder analyzer​(@Nullable java.lang.String value)
      The analyzer to use for the query string

      API name: analyzer

    • defaultOperator

      public final ValidateQueryRequest.Builder defaultOperator​(@Nullable Operator value)
      The default operator for query string query (AND or OR)

      API name: default_operator

    • df

      public final ValidateQueryRequest.Builder df​(@Nullable java.lang.String value)
      The field to use as default where no field prefix is given in the query string

      API name: df

    • expandWildcards

      public final ValidateQueryRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ValidateQueryRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • explain

      public final ValidateQueryRequest.Builder explain​(@Nullable java.lang.Boolean value)
      Return detailed information about the error

      API name: explain

    • ignoreUnavailable

      public final ValidateQueryRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      public final ValidateQueryRequest.Builder index​(java.util.List<java.lang.String> list)
      A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

      API name: index

      Adds all elements of list to index.

    • index

      public final ValidateQueryRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of index names to restrict the operation; use _all or empty string to perform the operation on all indices

      API name: index

      Adds one or more values to index.

    • lenient

      public final ValidateQueryRequest.Builder lenient​(@Nullable java.lang.Boolean value)
      Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

      API name: lenient

    • q

      public final ValidateQueryRequest.Builder q​(@Nullable java.lang.String value)
      Query in the Lucene query string syntax

      API name: q

    • query

      public final ValidateQueryRequest.Builder query​(@Nullable Query value)
      API name: query

    • query

      public final ValidateQueryRequest.Builder query​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      API name: query

    • rewrite

      public final ValidateQueryRequest.Builder rewrite​(@Nullable java.lang.Boolean value)
      Provide a more detailed explanation showing the actual Lucene query that will be executed.

      API name: rewrite

    • type

      public final ValidateQueryRequest.Builder type​(java.util.List<java.lang.String> list)
      A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types

      API name: type

      Adds all elements of list to type.

    • type

      public final ValidateQueryRequest.Builder type​(java.lang.String value, java.lang.String... values)
      A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types

      API name: type

      Adds one or more values to type.

    • self

      protected ValidateQueryRequest.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<ValidateQueryRequest.Builder>

    • build

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