Schedule now transform API

edit

Schedule now transform API

edit

Instantly runs a transform to process data.

Request

edit

POST _transform/<transform_id>/_schedule_now

Prerequisites

edit

Requires the manage_transform cluster privilege. This privilege is included in the transform_admin built-in role.

Description

edit

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

edit

<transform_id>: (Required, string) Identifier for the transform.

Query parameters

edit

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

edit

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
}

« Reset transform API Start transform API »