Files
elasticsearch-js/docs/reference/api/TransformUpdateTransformRequest.md
2025-05-27 15:30:21 -05:00

2.2 KiB

Interface TransformUpdateTransformRequest

Name Type Description
_meta Metadata Defines optional transform metadata.
body string ({ [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; _meta?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; })
defer_validation boolean When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.
description string Free text description of the transform.
dest TransformDestination The destination for the transform.
frequency Duration The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.
querystring { [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; _meta?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; } All values in querystring will be added to the request querystring.
retention_policy TransformRetentionPolicyContainer null
settings TransformSettings Defines optional transform settings.
source TransformSource The source of the data for the transform.
sync TransformSyncContainer Defines the properties transforms require to run continuously.
timeout Duration Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
transform_id Id Identifier for the transform.