Class TermsEnumRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.TermsEnumRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class TermsEnumRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TermsEnumRequest.Builder
Builder forTermsEnumRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<TermsEnumRequest>
_DESERIALIZER
Json deserializer forTermsEnumRequest
static Endpoint<TermsEnumRequest,TermsEnumResponse,ElasticsearchError>
ENDPOINT
Endpoint "terms_enum
". -
Constructor Summary
Constructors Constructor Description TermsEnumRequest(TermsEnumRequest.Builder builder)
TermsEnumRequest(java.util.function.Function<TermsEnumRequest.Builder,TermsEnumRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
caseInsensitive()
When true the provided search string is matched against index terms without case sensitivity.java.lang.String
field()
Required - The string to match at the start of indexed terms.java.lang.String
index()
Required - Comma-separated list of data streams, indices, and index aliases to search.Query
indexFilter()
Allows to filter an index shard if the provided query rewrites to match_none.java.lang.String
searchAfter()
API name:search_after
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupTermsEnumRequestDeserializer(DelegatingDeserializer<TermsEnumRequest.Builder> op)
java.lang.Integer
size()
How many matching terms to return.java.lang.String
string()
The string after which terms in the index should be returned.java.lang.String
timeout()
The maximum length of time to spend collecting results.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forTermsEnumRequest
-
ENDPOINT
Endpoint "terms_enum
".
-
-
Constructor Details
-
TermsEnumRequest
-
TermsEnumRequest
public TermsEnumRequest(java.util.function.Function<TermsEnumRequest.Builder,TermsEnumRequest.Builder> fn)
-
-
Method Details
-
index
public java.lang.String index()Required - Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.API name:
index
-
field
public java.lang.String 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
-
size
@Nullable public java.lang.Integer size()How many matching terms to return.API name:
size
-
timeout
@Nullable public java.lang.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
-
caseInsensitive
@Nullable public java.lang.Boolean caseInsensitive()When true the provided search string is matched against index terms without case sensitivity.API name:
case_insensitive
-
indexFilter
Allows to filter an index shard if the provided query rewrites to match_none.API name:
index_filter
-
string
@Nullable public java.lang.String 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
-
searchAfter
@Nullable public java.lang.String searchAfter()API name:search_after
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupTermsEnumRequestDeserializer
protected static void setupTermsEnumRequestDeserializer(DelegatingDeserializer<TermsEnumRequest.Builder> op)
-