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

76 lines
4.0 KiB
Plaintext

[[reference-connector-sync_job_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.syncJobPost]]
=== client.connector.syncJobPost
Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
{ref}/create-connector-sync-job-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorSyncJobPostRequest, options?): Promise<ConnectorSyncJobPostResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
id: <<Id>>
job_type?: <<ConnectorSyncJobType>>
trigger_method?: <<ConnectorSyncJobTriggerMethod>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface ConnectorSyncJobPostResponse {
id: <<Id>>
}
[pass]
++++
</pre>
++++