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

75 lines
4.0 KiB
Plaintext

[[reference-connector-update_index_name]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.updateIndexName]]
=== client.connector.updateIndexName
Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.
{ref}/update-connector-index-name-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorUpdateIndexNameRequest, options?): Promise<ConnectorUpdateIndexNameResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface ConnectorUpdateIndexNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
index_name: <<SpecUtilsWithNullValue>><<<IndexName>>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface ConnectorUpdateIndexNameResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++