Class CountRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<CountRequest.Builder>
implements ObjectBuilder<CountRequest>
Builder for
CountRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal CountRequest.Builder
allowNoIndices
(Boolean value) Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final CountRequest.Builder
Analyzer to use for the query string.final CountRequest.Builder
analyzeWildcard
(Boolean value) Iftrue
, wildcard and prefix queries are analyzed.build()
Builds aCountRequest
.final CountRequest.Builder
defaultOperator
(Operator value) The default operator for query string query:AND
orOR
.final CountRequest.Builder
Field to use as default where no field prefix is given in the query string.final CountRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Type of index that wildcard patterns can match.final CountRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Type of index that wildcard patterns can match.final CountRequest.Builder
ignoreThrottled
(Boolean value) Iftrue
, concrete, expanded or aliased indices are ignored when frozen.final CountRequest.Builder
ignoreUnavailable
(Boolean value) Iffalse
, the request returns an error if it targets a missing or closed index.final CountRequest.Builder
Comma-separated list of data streams, indices, and aliases to search.final CountRequest.Builder
Comma-separated list of data streams, indices, and aliases to search.final CountRequest.Builder
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.final CountRequest.Builder
Sets the minimum_score
value that documents must have to be included in the result.final CountRequest.Builder
preference
(String value) Specifies the node or shard the operation should be performed on.final CountRequest.Builder
Query in the Lucene query string syntax.final CountRequest.Builder
Defines the search definition using the Query DSL.final CountRequest.Builder
Defines the search definition using the Query DSL.final CountRequest.Builder
Custom value used to route operations to a specific shard.protected CountRequest.Builder
self()
final CountRequest.Builder
terminateAfter
(Long value) Maximum number of documents to collect for each shard.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices.API name:
allow_no_indices
-
analyzeWildcard
Iftrue
, wildcard and prefix queries are analyzed. This parameter can only be used when theq
query string parameter is specified.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string. This parameter can only be used when theq
query string parameter is specified.API name:
analyzer
-
defaultOperator
The default operator for query string query:AND
orOR
. This parameter can only be used when theq
query string parameter is specified.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string. This parameter can only be used when theq
query string parameter is specified.API name:
df
-
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 asopen,hidden
.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
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 asopen,hidden
.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
ignoreThrottled
Iftrue
, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*
). To search all data streams and indices, omit this parameter or use*
or_all
.API name:
index
Adds all elements of
list
toindex
. -
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*
). To search all data streams and indices, omit this parameter or use*
or_all
.API name:
index
Adds one or more values to
index
. -
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.API name:
lenient
-
minScore
Sets the minimum_score
value that documents must have to be included in the result.API name:
min_score
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
q
Query in the Lucene query string syntax.API name:
q
-
query
Defines the search definition using the Query DSL.API name:
query
-
query
Defines the search definition using the Query DSL.API name:
query
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
terminateAfter
Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.API name:
terminate_after
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CountRequest.Builder>
-
build
Builds aCountRequest
.- Specified by:
build
in interfaceObjectBuilder<CountRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-