Package co.elastic.clients.elasticsearch.watcher

Class DeleteWatchRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.watcher.DeleteWatchRequest

public class DeleteWatchRequest
extends RequestBase

Delete a watch. When the watch is removed, the document representing the watch in the .watches index is gone and it will never be run again.

Deleting a watch does not delete any watch execution records related to this watch from the watch history.

IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the .watches index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the .watches index.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteWatchRequest,DeleteWatchResponse,ErrorResponse>	_ENDPOINT	Endpoint "watcher.delete_watch".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - The watch identifier.
static DeleteWatchRequest	of(Function<DeleteWatchRequest.Builder,ObjectBuilder<DeleteWatchRequest>> fn)

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<DeleteWatchRequest,DeleteWatchResponse,ErrorResponse> _ENDPOINT

Endpoint "watcher.delete_watch".

Method Details

of

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

id

public final String id()

Required - The watch identifier.

API name: id