@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/text_structure.find_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","type":"object","properties":{"charset":{"type":"string","description":"The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.","x-found-in":"query"},"column_names":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.","x-found-in":"query"},"format":{"$ref":"./text_structure.find_structure.json#/$defs/text_structure.find_structure__FindStructureFormat","description":"The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"has_header_row":{"type":"boolean","description":"If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.","x-found-in":"query"},"line_merge_size_limit":{"type":"number","description":"The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.","x-found-in":"query"},"lines_to_sample":{"type":"number","description":"The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.","x-found-in":"query"},"quote":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"}},"description":"Find the structure of a text file.\n\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_structure","type":"object","properties":{"charset":{"type":"string","description":"The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.","x-found-in":"query"},"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"type":"string","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.","x-found-in":"query"},"format":{"$ref":"./text_structure.find_structure.json#/$defs/text_structure.find_structure__FindStructureFormat","description":"The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"has_header_row":{"type":"boolean","description":"If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.","x-found-in":"query"},"line_merge_size_limit":{"type":"number","description":"The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.","x-found-in":"query"},"lines_to_sample":{"type":"number","description":"The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.","x-found-in":"query"},"quote":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"text_files":{"type":"array","items":{},"x-found-in":"body"}},"description":"Find the structure of a text file.\n\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters."}

package/src/es/json/transform.delete_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"force":{"type":"boolean","description":"If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.","x-found-in":"query"},"delete_dest_index":{"type":"boolean","description":"If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["transform_id"],"description":"Delete a transform."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.delete_transform","type":"object","properties":{"force":{"type":"boolean","description":"If this value is false, the transform must be stopped before it can be deleted. If true, the transform is\ndeleted regardless of its current state.","x-found-in":"query"},"delete_dest_index":{"type":"boolean","description":"If this value is true, the destination index is deleted together with the transform. If false, the destination\nindex will not be deleted","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Delete a transform."}

package/src/es/json/transform.get_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","type":"object","properties":{"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"}},"description":"Get transforms.\n\nGet configuration information for transforms."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"exclude_generated":{"type":"boolean","description":"Excludes fields that were automatically added when creating the\ntransform. This allows the configuration to be in an acceptable format to\nbe retrieved and then added to another cluster.","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"}},"description":"Get transforms.\n\nGet configuration information for transforms."}

package/src/es/json/transform.get_transform_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform_stats","type":"object","properties":{"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"basic":{"type":"boolean","description":"If true, the response includes `id`, `state`, `node`, `stats`, `health`,\nand basic `checkpointing` information (the last and next checkpoint\nnumbers, and the next checkpoint's `position` and `progress`). Skips\nstatistics that require heavy computations to calculate:\n`operations_behind`, `changes_last_detected_at`, `last_search_time`, and\nthe checkpoint timestamps.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the stats","x-found-in":"query"}},"required":["transform_id"],"description":"Get transform stats.\n\nGet usage information for transforms."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.get_transform_stats","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request:\n\n1. Contains wildcard expressions and there are no transforms that match.\n2. Contains the _all string or no identifiers and there are no matches.\n3. Contains wildcard expressions and there are only partial matches.\n\nIf this parameter is false, the request returns a 404 status code when\nthere are no matches or only partial matches.","x-found-in":"query"},"basic":{"type":"boolean","description":"If true, the response includes `id`, `state`, `node`, `stats`, `health`,\nand basic `checkpointing` information (the last and next checkpoint\nnumbers, and the next checkpoint's `position` and `progress`). Skips\nstatistics that require heavy computations to calculate:\n`operations_behind`, `changes_last_detected_at`, `last_search_time`, and\nthe checkpoint timestamps.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of transforms.","x-found-in":"query"},"size":{"type":"number","description":"Specifies the maximum number of transforms to obtain.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the stats","x-found-in":"query"},"transform_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"Identifier for the transform. It can be a transform identifier or a\nwildcard expression. You can get information for all transforms by using\n`_all`, by specifying `*` as the `<transform_id>`, or by omitting the\n`<transform_id>`.","x-found-in":"path"}},"required":["transform_id"],"description":"Get transform stats.\n\nGet usage information for transforms."}

package/src/es/json/transform.preview_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"}},"description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.preview_transform","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it.\nThese objects define the group by fields and the aggregation to reduce\nthe data.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for\neach unique key.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform\nconfiguration details in the request body.","x-found-in":"path"}},"description":"Preview a transform.\n\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations."}

package/src/es/json/transform.put_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.put_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"},"defer_validation":{"type":"boolean","description":"When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for each unique key.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"}},"required":["transform_id","dest","source"],"description":"Create a transform.\n\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.put_transform","type":"object","properties":{"defer_validation":{"type":"boolean","description":"When the transform is created, a series of validations occur to ensure its success. For example, there is a\ncheck for the existence of the source indices and a check that the destination index is not part of the source\nindex pattern. You can use this parameter to skip the checks, for example when the source index does not exist\nuntil after the transform is created. The validations are always run when you start the transform, however, with\nthe exception of privilege checks.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the transform is running continuously. Also\ndetermines the retry interval in the event of transient failures while the transform is searching or indexing.\nThe minimum value is `1s` and the maximum is `1h`.","x-found-in":"body"},"latest":{"$ref":"./transform._types.json#/$defs/transform._types__Latest","description":"The latest method transforms the data by finding the latest document for each unique key.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"pivot":{"$ref":"./transform._types.json#/$defs/transform._types__Pivot","description":"The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields\nand the aggregation to reduce the data.","x-found-in":"body"},"retention_policy":{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer","description":"Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the\ndestination index.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["transform_id","dest","source"],"description":"Create a transform.\n\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices."}

package/src/es/json/transform.reset_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.reset_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"},"force":{"type":"boolean","description":"If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["transform_id"],"description":"Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.reset_transform","type":"object","properties":{"force":{"type":"boolean","description":"If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform\nmust be stopped before it can be reset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.","x-found-in":"path"}},"required":["transform_id"],"description":"Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted."}

package/src/es/json/transform.schedule_now_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.schedule_now_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the scheduling to take place","x-found-in":"query"},"defer":{"type":"boolean","description":"When true, defers the scheduling by the transform's configured sync delay\ninstead of triggering immediately. The transform will process new data after\nthe delay elapses rather than right away.","x-found-in":"query"}},"required":["transform_id"],"description":"Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.schedule_now_transform","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Controls the time to wait for the scheduling to take place","x-found-in":"query"},"defer":{"type":"boolean","description":"When true, defers the scheduling by the transform's configured sync delay\ninstead of triggering immediately. The transform will process new data after\nthe delay elapses rather than right away.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime."}

package/src/es/json/transform.start_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.start_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"from":{"type":"string","description":"Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.","x-found-in":"query"}},"required":["transform_id"],"description":"Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.start_transform","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"from":{"type":"string","description":"Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations."}

package/src/es/json/transform.stop_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.stop_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.","x-found-in":"path"},"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"force":{"type":"boolean","description":"If it is true, the API forcefully stops the transforms.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.","x-found-in":"query"},"wait_for_checkpoint":{"type":"boolean","description":"If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"}},"required":["transform_id"],"description":"Stop transforms.\n\nStops one or more transforms."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.stop_transform","type":"object","properties":{"allow_no_match":{"type":"boolean","description":"Specifies what to do when the request: contains wildcard expressions and there are no transforms that match;\ncontains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there\nare only partial matches.\n\nIf it is true, the API returns a successful acknowledgement message when there are no matches. When there are\nonly partial matches, the API stops the appropriate transforms.\n\nIf it is false, the request returns a 404 status code when there are no matches or only partial matches.","x-found-in":"query"},"force":{"type":"boolean","description":"If it is true, the API forcefully stops the transforms.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the\ntimeout expires, the request returns a timeout exception. However, the request continues processing and\neventually moves the transform to a STOPPED state.","x-found-in":"query"},"wait_for_checkpoint":{"type":"boolean","description":"If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false,\nthe transform stops as soon as possible.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns\nimmediately and the indexer is stopped asynchronously in the background.","x-found-in":"query"},"transform_id":{"type":"string","description":"Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression.\nTo stop all transforms, use `_all` or `*` as the identifier.","x-found-in":"path"}},"required":["transform_id"],"description":"Stop transforms.\n\nStops one or more transforms."}

package/src/es/json/transform.update_transform.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","type":"object","properties":{"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"},"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"oneOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"}},"required":["transform_id"],"description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"transform.update_transform","type":"object","properties":{"defer_validation":{"type":"boolean","description":"When true, deferrable validations are not run. This behavior may be\ndesired if the source index does not exist until after the transform is\ncreated.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\ntimeout expires, the request fails and returns an error.","x-found-in":"query"},"dest":{"$ref":"./transform._types.json#/$defs/transform._types__Destination","description":"The destination for the transform.","x-found-in":"body"},"description":{"type":"string","description":"Free text description of the transform.","x-found-in":"body"},"frequency":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The interval between checks for changes in the source indices when the\ntransform is running continuously. Also determines the retry interval in\nthe event of transient failures while the transform is searching or\nindexing. The minimum value is 1s and the maximum is 1h.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Defines optional transform metadata.","x-found-in":"body"},"source":{"$ref":"./transform._types.json#/$defs/transform._types__Source","description":"The source of the data for the transform.","x-found-in":"body"},"settings":{"$ref":"./transform._types.json#/$defs/transform._types__Settings","description":"Defines optional transform settings.","x-found-in":"body"},"sync":{"$ref":"./transform._types.json#/$defs/transform._types__SyncContainer","description":"Defines the properties transforms require to run continuously.","x-found-in":"body"},"retention_policy":{"anyOf":[{"$ref":"./transform._types.json#/$defs/transform._types__RetentionPolicyContainer"},{"type":"null"}],"description":"Defines a retention policy for the transform. Data that meets the defined\ncriteria is deleted from the destination index.","x-found-in":"body"},"transform_id":{"type":"string","description":"Identifier for the transform.","x-found-in":"path"}},"required":["transform_id"],"description":"Update a transform.\n\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges."}

package/src/es/json/update.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the document to be updated.","x-found-in":"path"},"index":{"type":"string","description":"The name of the target index.\nBy default, the index is created automatically if it doesn't exist.","x-found-in":"path"},"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"lang":{"type":"string","description":"The script language.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be an index alias.","x-found-in":"query"},"retry_on_conflict":{"type":"number","description":"The number of times the operation should be retried when a conflict occurs.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to exclude.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to retrieve.","x-found-in":"query"},"detect_noop":{"type":"boolean","description":"If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.","x-found-in":"body"},"doc":{"description":"A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.","x-found-in":"body"},"doc_as_upsert":{"type":"boolean","description":"If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document.","x-found-in":"body"},"scripted_upsert":{"type":"boolean","description":"If `true`, run the script whether or not the document exists.","x-found-in":"body"},"upsert":{"description":"If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.","x-found-in":"body"}},"required":["id","index"],"description":"Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update","type":"object","properties":{"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"include_source_on_error":{"type":"boolean","description":"True or false if to include the document source in the error message in case of parsing errors.","x-found-in":"query"},"lang":{"type":"string","description":"The script language.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be an index alias.","x-found-in":"query"},"retry_on_conflict":{"type":"number","description":"The number of times the operation should be retried when a conflict occurs.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of copies of each shard that must be active before proceeding with the operation.\nSet to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1).\nThe default value of `1` means it waits for each primary shard to be active.","x-found-in":"query"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig","description":"If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.","x-found-in":"body"},"_source_excludes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to exclude.","x-found-in":"query"},"_source_includes":{"$ref":"./_types.json#/$defs/_types__Fields","description":"The source fields you want to retrieve.","x-found-in":"query"},"detect_noop":{"type":"boolean","description":"If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.","x-found-in":"body"},"doc":{"description":"A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.","x-found-in":"body"},"doc_as_upsert":{"type":"boolean","description":"If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document.","x-found-in":"body"},"scripted_upsert":{"type":"boolean","description":"If `true`, run the script whether or not the document exists.","x-found-in":"body"},"upsert":{"description":"If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.","x-found-in":"body"},"id":{"type":"string","description":"A unique identifier for the document to be updated.","x-found-in":"path"},"index":{"type":"string","description":"The name of the target index.\nBy default, the index is created automatically if it doesn't exist.","x-found-in":"path"}},"required":["id","index"],"description":"Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).\nFor usage examples such as partial updates, upserts, and scripted updates, see the External documentation."}

package/src/es/json/update_by_query.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.","x-found-in":"body"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_docs":{"type":"number","description":"The maximum number of documents to update.","x-found-in":"body"},"pipeline":{"type":"string","description":"The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"An explicit timeout for each search request.\nBy default, there is no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"type":"boolean","description":"Should the document increment the version number (internal) on hit or not (reindex)","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.\nUpdate by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to update using the Query DSL.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document source or metadata when updating.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"}},"required":["index"],"description":"Update documents.\n\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.","x-found-in":"body"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_docs":{"type":"number","description":"The maximum number of documents to update.","x-found-in":"body"},"pipeline":{"type":"string","description":"The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"An explicit timeout for each search request.\nBy default, there is no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of <field>:<direction> pairs.","x-found-in":"query"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","x-found-in":"query"},"version_type":{"type":"boolean","description":"Should the document increment the version number (internal) on hit or not (reindex)","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe `timeout` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.\nUpdate by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to update using the Query DSL.","x-found-in":"body"},"script":{"$ref":"./_types.json#/$defs/_types__Script","description":"The script to run to update the document source or metadata when updating.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"required":["index"],"description":"Update documents.\n\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Refreshing shards**\n\nSpecifying the `refresh` parameter refreshes all shards once the request completes.\nThis is different to the update API's `refresh` parameter, which causes only the shard\nthat received the request to be refreshed. Unlike the update API, it does not support\n`wait_for`.\n\n**Running update by query asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch\nperforms some preflight checks, launches the request, and returns a\n[task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\nRefer to the linked documentation for examples of how to update documents using the `_update_by_query` API:"}

package/src/es/json/update_by_query_rethrottle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query_rethrottle","type":"object","properties":{"task_id":{"type":"string","description":"The ID for the task.","x-found-in":"path"},"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"}},"required":["task_id","requests_per_second"],"description":"Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"update_by_query_rethrottle","type":"object","properties":{"requests_per_second":{"type":"number","description":"The maximum number of documents to update per second, across the entire update_by_query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"task_id":{"type":"string","description":"The ID for the task.","x-found-in":"path"}},"required":["task_id","requests_per_second"],"description":"Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts."}