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

69 lines
4.1 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`
[source,ts]
----
interface ConnectorListRequest extends <<shared-type-request-base, RequestBase>> {
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
index_name?: <<shared-type-indices, Indices>>
connector_name?: <<shared-type-names, Names>>
service_type?: <<shared-type-names, Names>>
query?: string
}
----
[discrete]
===== `ConnectorListResponse`
[source,ts]
----
interface ConnectorListResponse {
count: <<shared-type-long, long>>
results: ConnectorConnector[]
}
----