Class TermsEnumRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<TermsEnumRequest.Builder>
co.elastic.clients.elasticsearch.core.TermsEnumRequest.Builder
- All Implemented Interfaces:
WithJson<TermsEnumRequest.Builder>
,ObjectBuilder<TermsEnumRequest>
- Enclosing class:
- TermsEnumRequest
public static class TermsEnumRequest.Builder extends WithJsonObjectBuilderBase<TermsEnumRequest.Builder> implements ObjectBuilder<TermsEnumRequest>
Builder for
TermsEnumRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description TermsEnumRequest
build()
Builds aTermsEnumRequest
.TermsEnumRequest.Builder
caseInsensitive(java.lang.Boolean value)
When true the provided search string is matched against index terms without case sensitivity.TermsEnumRequest.Builder
field(java.lang.String value)
Required - The string to match at the start of indexed terms.TermsEnumRequest.Builder
index(java.lang.String value)
Required - Comma-separated list of data streams, indices, and index aliases to search.TermsEnumRequest.Builder
indexFilter(Query value)
Allows to filter an index shard if the provided query rewrites to match_none.TermsEnumRequest.Builder
indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
Allows to filter an index shard if the provided query rewrites to match_none.TermsEnumRequest.Builder
searchAfter(java.lang.String value)
API name:search_after
protected TermsEnumRequest.Builder
self()
TermsEnumRequest.Builder
size(java.lang.Integer value)
How many matching terms to return.TermsEnumRequest.Builder
string(java.lang.String value)
The string after which terms in the index should be returned.TermsEnumRequest.Builder
timeout(Time value)
The maximum length of time to spend collecting results.TermsEnumRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The maximum length of time to spend collecting results.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
caseInsensitive
When true the provided search string is matched against index terms without case sensitivity.API name:
case_insensitive
-
field
Required - The string to match at the start of indexed terms. If not provided, all terms in the field are considered.API name:
field
-
index
Required - Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.API name:
index
-
indexFilter
Allows to filter an index shard if the provided query rewrites to match_none.API name:
index_filter
-
indexFilter
public final TermsEnumRequest.Builder indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)Allows to filter an index shard if the provided query rewrites to match_none.API name:
index_filter
-
searchAfter
API name:search_after
-
size
How many matching terms to return.API name:
size
-
string
The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.API name:
string
-
timeout
The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty.API name:
timeout
-
timeout
public final TermsEnumRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty.API name:
timeout
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<TermsEnumRequest.Builder>
-
build
Builds aTermsEnumRequest
.- Specified by:
build
in interfaceObjectBuilder<TermsEnumRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-