Package co.elastic.clients.elasticsearch.core

Class CountRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final CountRequest.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 CountRequest.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 CountRequest.Builder analyzer​(@Nullable java.lang.String value)
      The analyzer to use for the query string

      API name: analyzer

    • defaultOperator

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

      API name: default_operator

    • df

      public final CountRequest.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 CountRequest.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 CountRequest.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.

    • ignoreThrottled

      public final CountRequest.Builder ignoreThrottled​(@Nullable java.lang.Boolean value)
      Whether specified concrete, expanded or aliased indices should be ignored when throttled

      API name: ignore_throttled

    • ignoreUnavailable

      public final CountRequest.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 CountRequest.Builder index​(java.util.List<java.lang.String> list)
      A comma-separated list of indices to restrict the results

      API name: index

      Adds all elements of list to index.

    • index

      public final CountRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of indices to restrict the results

      API name: index

      Adds one or more values to index.

    • lenient

      public final CountRequest.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

    • minScore

      public final CountRequest.Builder minScore​(@Nullable java.lang.Double value)
      Include only documents with a specific _score value in the result

      API name: min_score

    • preference

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

      API name: preference

    • q

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

      API name: q

    • query

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

    • query

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

    • routing

      public final CountRequest.Builder routing​(@Nullable java.lang.String value)
      A comma-separated list of specific routing values

      API name: routing

    • terminateAfter

      public final CountRequest.Builder terminateAfter​(@Nullable java.lang.Long value)
      The maximum count for each shard, upon reaching which the query execution will terminate early

      API name: terminate_after

    • type

      public final CountRequest.Builder type​(java.util.List<java.lang.String> list)
      A comma-separated list of types to restrict the results

      API name: type

      Adds all elements of list to type.

    • type

      public final CountRequest.Builder type​(java.lang.String value, java.lang.String... values)
      A comma-separated list of types to restrict the results

      API name: type

      Adds one or more values to type.

    • self

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

    • build

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