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

81 lines
3.9 KiB
Plaintext

[[reference-connector-put]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.put]]
=== client.connector.put
Create or update a connector.
{ref}/create-connector-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorPutRequest, options?): Promise<ConnectorPutResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface ConnectorPutRequest extends <<RequestBase>> {
connector_id?: <<Id>>
description?: string
index_name?: <<IndexName>>
is_native?: boolean
language?: string
name?: string
service_type?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface ConnectorPutResponse {
result: <<Result>>
id: <<Id>>
}
[pass]
++++
</pre>
++++