mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
01751c0298
* [Docs] Add connectors links
* 🧹 Cleanup abbreviations, add missing tech preview labels
* Unify remaining tech preview, abbreviations, update CLI verbiage
* Unify remaining tech preview, abbreviations
112 lines
3.1 KiB
Text
112 lines
3.1 KiB
Text
[[update-connector-scheduling-api]]
|
|
=== Update connector scheduling API
|
|
++++
|
|
<titleabbrev>Update connector scheduling</titleabbrev>
|
|
++++
|
|
|
|
preview::[]
|
|
|
|
Updates the `scheduling` configuration of a connector.
|
|
|
|
[[update-connector-scheduling-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`PUT _connector/<connector_id>/_scheduling`
|
|
|
|
[[update-connector-scheduling-api-prereq]]
|
|
==== {api-prereq-title}
|
|
|
|
* To sync data using connectors, it's essential to have the Elastic connectors service running.
|
|
* The `connector_id` parameter should reference an existing connector.
|
|
|
|
[[update-connector-scheduling-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<connector_id>`::
|
|
(Required, string)
|
|
|
|
[role="child_attributes"]
|
|
[[update-connector-scheduling-api-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
`scheduling`::
|
|
(Required, object) The scheduling configuration for the connector. This configuration determines frequency of synchronization operations for the connector.
|
|
|
|
The scheduling configuration includes the following attributes, each represented as a `ScheduleConfig` object:
|
|
|
|
- `access_control` (Required, `ScheduleConfig` object) Defines the schedule for synchronizing access control settings of the connector.
|
|
|
|
- `full` (Required, `ScheduleConfig` object) Defines the schedule for a full content syncs.
|
|
|
|
- `incremental` (Required, `ScheduleConfig` object) Defines the schedule for incremental content syncs.
|
|
|
|
Each `ScheduleConfig` object includes the following sub-attributes:
|
|
|
|
- `enabled` (Required, boolean) A flag that enables or disables the scheduling.
|
|
|
|
- `interval` (Required, string) A CRON expression representing the sync schedule. This expression defines the grequency at which the sync operations should occur. It must be provided in a valid CRON format.
|
|
|
|
|
|
[[update-connector-scheduling-api-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`200`::
|
|
Connector `scheduling` field was successfully updated.
|
|
|
|
`400`::
|
|
The `connector_id` was not provided or the request payload was malformed.
|
|
|
|
`404` (Missing resources)::
|
|
No connector matching `connector_id` could be found.
|
|
|
|
[[update-connector-scheduling-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example updates the `scheduling` property for the connector with ID `my-connector`:
|
|
|
|
////
|
|
[source, console]
|
|
--------------------------------------------------
|
|
PUT _connector/my-connector
|
|
{
|
|
"index_name": "search-google-drive",
|
|
"name": "My Connector",
|
|
"service_type": "google_drive"
|
|
}
|
|
--------------------------------------------------
|
|
// TESTSETUP
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _connector/my-connector
|
|
--------------------------------------------------
|
|
// TEARDOWN
|
|
////
|
|
|
|
[source,console]
|
|
----
|
|
PUT _connector/my-connector/_scheduling
|
|
{
|
|
"scheduling": {
|
|
"access_control": {
|
|
"enabled": true,
|
|
"interval": "0 10 0 * * ?"
|
|
},
|
|
"full": {
|
|
"enabled": true,
|
|
"interval": "0 20 0 * * ?"
|
|
},
|
|
"incremental": {
|
|
"enabled": false,
|
|
"interval": "0 30 0 * * ?"
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"result": "updated"
|
|
}
|
|
----
|