97 lines
5.1 KiB
Plaintext
97 lines
5.1 KiB
Plaintext
[[reference-transform-update_transform]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.transform.updateTransform]]
|
|
=== client.transform.updateTransform
|
|
|
|
Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.
|
|
|
|
{ref}/update-transform.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(TransformUpdateTransformRequest, options?): Promise<TransformUpdateTransformResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TransformUpdateTransformRequest extends <<RequestBase>> {
|
|
transform_id: <<Id>>
|
|
defer_validation?: boolean
|
|
timeout?: <<Duration>>
|
|
dest?: <<TransformDestination>>
|
|
description?: string
|
|
frequency?: <<Duration>>
|
|
_meta?: <<Metadata>>
|
|
source?: <<TransformSource>>
|
|
settings?: <<TransformSettings>>
|
|
sync?: <<TransformSyncContainer>>
|
|
retention_policy?: <<TransformRetentionPolicyContainer>> | null
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TransformUpdateTransformResponse {
|
|
authorization?: <<MlTransformAuthorization>>
|
|
create_time: <<long>>
|
|
description: string
|
|
dest: <<ReindexDestination>>
|
|
frequency?: <<Duration>>
|
|
id: <<Id>>
|
|
latest?: <<TransformLatest>>
|
|
pivot?: <<TransformPivot>>
|
|
retention_policy?: <<TransformRetentionPolicyContainer>>
|
|
settings: <<TransformSettings>>
|
|
source: <<ReindexSource>>
|
|
sync?: <<TransformSyncContainer>>
|
|
version: <<VersionString>>
|
|
_meta?: <<Metadata>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|