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

64 lines
4.0 KiB
Plaintext

[[reference-connector-update_pipeline]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.connector.updatePipeline
Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
{ref}/update-connector-pipeline-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorUpdatePipelineRequest, options?): Promise<ConnectorUpdatePipelineResponse>
----
[discrete]
===== `ConnectorUpdatePipelineRequest`
[source,ts]
----
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
connector_id: <<Id>>
pipeline: ConnectorIngestPipelineParams
}
----
[discrete]
===== `ConnectorUpdatePipelineResponse`
[source,ts]
----
interface ConnectorUpdatePipelineResponse {
result: <<Result>>
}
----