63 lines
4.1 KiB
Plaintext
63 lines
4.1 KiB
Plaintext
[[reference-connector-sync_job_cancel]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.syncJobCancel
|
|
|
|
Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.
|
|
|
|
{ref}/cancel-connector-sync-job-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(ConnectorSyncJobCancelRequest, options?): Promise<ConnectorSyncJobCancelResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `ConnectorSyncJobCancelRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface ConnectorSyncJobCancelRequest extends <<shared-type-request-base, RequestBase>> {
|
|
connector_sync_job_id: <<shared-type-id, Id>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `ConnectorSyncJobCancelResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface ConnectorSyncJobCancelResponse {
|
|
result: <<shared-type-result, Result>>
|
|
}
|
|
----
|
|
|