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

79 lines
3.9 KiB
Plaintext

[[reference-connector-list]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.list
Get all connectors. Get information about all connectors.
{ref}/list-connector-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorListRequest, options?): Promise<ConnectorListResponse>
----
[discrete]
==== ConnectorListRequest
[pass]
++++
<pre>
++++
interface ConnectorListRequest extends <<RequestBase>> {
from?: number
size?: number
index_name?: <<Indices>>
connector_name?: <<Names>>
service_type?: <<Names>>
query?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== ConnectorListResponse
[pass]
++++
<pre>
++++
interface ConnectorListResponse {
count: number
results: ConnectorConnector[]
}
[pass]
++++
</pre>
++++