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

68 lines
4.1 KiB
Plaintext

[[reference-connector-sync_job_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.syncJobList
Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order.
{ref}/list-connector-sync-jobs-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ConnectorSyncJobListRequest, options?): Promise<ConnectorSyncJobListResponse>
----
[discrete]
===== `ConnectorSyncJobListRequest`
[source,ts]
----
interface ConnectorSyncJobListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
status?: ConnectorSyncStatus
connector_id?: <<Id>>
job_type?: ConnectorSyncJobType | ConnectorSyncJobType[]
}
----
[discrete]
===== `ConnectorSyncJobListResponse`
[source,ts]
----
interface ConnectorSyncJobListResponse {
count: <<long>>
results: ConnectorConnectorSyncJob[]
}
----