Files
elasticsearch-js/docs/reference-enrich-execute_policy.asciidoc
2024-12-05 14:46:51 -06:00

65 lines
3.9 KiB
Plaintext

[[reference-enrich-execute_policy]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.enrich.executePolicy
Creates the enrich index for an existing enrich policy.
{ref}/execute-enrich-policy-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(EnrichExecutePolicyRequest, options?): Promise<EnrichExecutePolicyResponse>
----
[discrete]
===== `EnrichExecutePolicyRequest`
[source,ts]
----
interface EnrichExecutePolicyRequest extends <<RequestBase>> {
name: <<Name>>
wait_for_completion?: boolean
}
----
[discrete]
===== `EnrichExecutePolicyResponse`
[source,ts]
----
interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: <<TaskId>>
}
----