Set connector sync job stats APIedit
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Sets connector sync job stats.
To get started with Connector APIs, check out the tutorial.
Requestedit
PUT _connector/_sync_job/<connector_sync_job_id>/_stats
Prerequisitesedit
- To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
-
The
connector_sync_job_id
parameter should reference an existing connector sync job.
Descriptionedit
Sets the stats for a connector sync job.
Stats include: deleted_document_count
, indexed_document_count
, indexed_document_volume
and total_document_count
.
last_seen
can also be updated using this API.
This API is mainly used by the connector service for updating sync job information.
Path parametersedit
-
<connector_sync_job_id>
- (Required, string)
Request bodyedit
-
deleted_document_count
- (Required, int) The number of documents the sync job deleted.
-
indexed_document_count
- (Required, int) The number of documents the sync job indexed.
-
indexed_document_volume
- (Required, int) The total size of the data (in MiB) the sync job indexed.
-
total_document_count
- (Optional, int) The total number of documents in the target index after the sync job finished.
-
last_seen
-
(Optional, instant) The timestamp to set the connector sync job’s
last_seen
property.
Response codesedit
-
200
- Indicates that the connector sync job stats were successfully updated.
-
404
-
No connector sync job matching
connector_sync_job_id
could be found.
Examplesedit
The following example sets all mandatory and optional stats for the connector sync job my-connector-sync-job
:
response = client.connector.sync_job_update_stats( connector_sync_job_id: 'my-connector-sync-job', body: { deleted_document_count: 10, indexed_document_count: 20, indexed_document_volume: 1000, total_document_count: 2000, last_seen: '2023-01-02T10:00:00Z' } ) puts response
PUT _connector/_sync_job/my-connector-sync-job/_stats { "deleted_document_count": 10, "indexed_document_count": 20, "indexed_document_volume": 1000, "total_document_count": 2000, "last_seen": "2023-01-02T10:00:00Z" }