habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/reference-watcher-put_watch.asciidoc Normal file
View File

@ -0,0 +1,77 @@
[[reference-watcher-put_watch]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.watcher.putWatch
Creates a new watch, or updates an existing one.
{ref}/watcher-api-put-watch.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(WatcherPutWatchRequest, options?): Promise<WatcherPutWatchResponse>
----
[discrete]
===== `WatcherPutWatchRequest`
[source,ts]
----
interface WatcherPutWatchRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
active?: boolean
if_primary_term?: <<shared-type-long, long>>
if_seq_no?: <<shared-type-sequence-number, SequenceNumber>>
version?: <<shared-type-version-number, VersionNumber>>
actions?: Record<string, WatcherAction>
condition?: WatcherConditionContainer
input?: WatcherInputContainer
metadata?: <<shared-type-metadata, Metadata>>
throttle_period?: string
transform?: <<shared-type-transform-container, TransformContainer>>
trigger?: WatcherTriggerContainer
}
----
[discrete]
===== `WatcherPutWatchResponse`
[source,ts]
----
interface WatcherPutWatchResponse {
created: boolean
_id: <<shared-type-id, Id>>
_primary_term: <<shared-type-long, long>>
_seq_no: <<shared-type-sequence-number, SequenceNumber>>
_version: <<shared-type-version-number, VersionNumber>>
}
----