Schedule now transform API
Instantly runs a transform to process data.
Request
POST _transform/<transform_id>/_schedule_now
Prerequisites
- Requires the
manage_transformcluster privilege. This privilege is included in thetransform_adminbuilt-in role.
Description
When you run this API, processing for the next checkpoint is started immediately without waiting for the configured frequency interval. The API returns immediately, data processing happens in the background. Subsequently, the transform will be processed again at now + frequency unless the API is called again in the meantime.
Path parameters
-
<transform_id> - (Required, string) Identifier for the transform.
Query parameters
-
timeout - (Optional, time) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to
30s.
Examples
resp = client.transform.schedule_now_transform(
transform_id="ecommerce_transform",
)
print(resp) response = client.transform.schedule_now_transform( transform_id: 'ecommerce_transform' ) puts response
const response = await client.transform.scheduleNowTransform({
transform_id: "ecommerce_transform",
});
console.log(response); POST _transform/ecommerce_transform/_schedule_now
When the transform is scheduled now, you receive the following results:
{
"acknowledged" : true
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html