Package co.elastic.clients.elasticsearch.watcher

Class AckWatchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.watcher.AckWatchRequest

public class AckWatchRequest
extends RequestBase

Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions.

The acknowledgement state of an action is stored in the status.actions.<id>.ack.state structure.

IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution.

Acknowledging an action throttles further executions of that action until its ack.state is reset to awaits_successful_execution. This happens when the condition of the watch is not met (the condition evaluates to false).

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<AckWatchRequest,AckWatchResponse,ErrorResponse>	_ENDPOINT	Endpoint "watcher.ack_watch".

Method Summary

Modifier and Type	Method	Description
final List<String>	actionId()	A comma-separated list of the action identifiers to acknowledge.
static AckWatchRequest	of(Function<AckWatchRequest.Builder,ObjectBuilder<AckWatchRequest>> fn)
final String	watchId()	Required - The watch identifier.

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

_ENDPOINT

public static final Endpoint<AckWatchRequest,AckWatchResponse,ErrorResponse> _ENDPOINT

Endpoint "watcher.ack_watch".

Method Details

of

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

actionId

public final List<String> actionId()

A comma-separated list of the action identifiers to acknowledge. If you omit this parameter, all of the actions of the watch are acknowledged.

API name: action_id

watchId

public final String watchId()

Required - The watch identifier.

API name: watch_id