Package co.elastic.clients.elasticsearch.watcher

Class QueryWatchesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.watcher.QueryWatchesRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class QueryWatchesRequest
extends RequestBase
implements JsonpSerializable

Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the _id and metadata.* fields are queryable or sortable.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryWatchesRequest.Builder	Builder for QueryWatchesRequest.

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 final JsonpDeserializer<QueryWatchesRequest>	_DESERIALIZER	Json deserializer for QueryWatchesRequest
static final Endpoint<QueryWatchesRequest,QueryWatchesResponse,ErrorResponse>	_ENDPOINT	Endpoint "watcher.query_watches".

Method Summary

Modifier and Type	Method	Description
final Integer	from()	The offset from the first result to fetch.
static QueryWatchesRequest	of(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)
final Query	query()	A query that filters the watches to be returned.
final List<FieldValue>	searchAfter()	Retrieve the next page of hits using a set of sort values from the previous page.
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	setupQueryWatchesRequestDeserializer(ObjectDeserializer<QueryWatchesRequest.Builder> op)
final Integer	size()	The number of hits to return.
final List<SortOptions>	sort()	One or more fields used to sort the search results.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<QueryWatchesRequest> _DESERIALIZER

Json deserializer for QueryWatchesRequest

_ENDPOINT

public static final Endpoint<QueryWatchesRequest,QueryWatchesResponse,ErrorResponse> _ENDPOINT

Endpoint "watcher.query_watches".

Method Details

of

public static QueryWatchesRequest of(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)

from

@Nullable
public final Integer from()

The offset from the first result to fetch. It must be non-negative.

API name: from

query

@Nullable
public final Query query()

A query that filters the watches to be returned.

API name: query

searchAfter

public final List<FieldValue> searchAfter()

Retrieve the next page of hits using a set of sort values from the previous page.

API name: search_after

size

@Nullable
public final Integer size()

The number of hits to return. It must be non-negative.

API name: size

sort

public final List<SortOptions> sort()

One or more fields used to sort the search results.

API name: sort

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupQueryWatchesRequestDeserializer

protected static void setupQueryWatchesRequestDeserializer(ObjectDeserializer<QueryWatchesRequest.Builder> op)