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

69 lines
4.3 KiB
Plaintext

[[reference-connector-post]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.post
Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.
{ref}/create-connector-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorPostRequest, options?): Promise<ConnectorPostResponse>
----
[discrete]
===== `ConnectorPostRequest`
[source,ts]
----
interface ConnectorPostRequest extends <<shared-type-request-base, RequestBase>> {
description?: string
index_name?: <<shared-type-index-name, IndexName>>
is_native?: boolean
language?: string
name?: string
service_type?: string
}
----
[discrete]
===== `ConnectorPostResponse`
[source,ts]
----
interface ConnectorPostResponse {
result: <<shared-type-result, Result>>
id: <<shared-type-id, Id>>
}
----