stack es transform put-transform cli command
Auth required
Idempotent
Scope: global
elastic stack es transform put-transform \
--dest <dest> \
--source <source> \
--transform-id <transform-id> \
[options]
Create a transform.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--deststringrequired- The destination for the transform.
--sourcestringrequired- The source of the data for the transform.
--transform-idstringrequired- Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.
--defer-validation- When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.
--timeoutstring- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
--descriptionstring- Free text description of the transform.
--frequencystring- 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
1sand the maximum is1h. --lateststring- The latest method transforms the data by finding the latest document for each unique key.
--metastring- Defines optional transform metadata.
--pivotstring- The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.
--retention-policystring- Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.
--settingsstring- Defines optional transform settings.
--syncstring- Defines the properties transforms require to run continuously.
--error-trace- When set to
trueElasticsearch will include the full stack trace of errors when they occur. --filter-pathstring-
Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
Repeatable: pass
--filter-pathmultiple times to supply more than one value --human- When set to
truewill return statistics in a format suitable for humans. For example"exists_time": "1h"for humans and"exists_time_in_millis": 3600000for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. --pretty- If set to
truethe returned JSON will be "pretty-formatted". Only use this option for debugging only. --input-filestring- path to a JSON file to use as command input
--dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--json-
output as JSON