diff --git a/output/schema/schema.json b/output/schema/schema.json index a53dc3b435..0c5dd5510f 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7432,7 +7432,8 @@ } }, "description": "Returns statistical information about geoip databases", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/geoip-stats-api.html", + "docId": "geoip-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "ingest.geo_ip_stats", "request": { "name": "Request", @@ -7514,7 +7515,8 @@ } }, "description": "Returns a list of the built-in patterns.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get", + "docId": "grok-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -7552,7 +7554,8 @@ } }, "description": "Creates or updates a pipeline.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html", + "docId": "ingest", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -125672,6 +125675,7 @@ }, "properties": [ { + "description": "The field to be appended to.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -125683,6 +125687,7 @@ } }, { + "description": "The value to be appended. Supports template snippets.", "name": "value", "required": true, "type": { @@ -125693,8 +125698,10 @@ } }, { + "description": "If `false`, the processor does not append values already present in the field.", "name": "allow_duplicates", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -125704,7 +125711,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L90-L94" + "specLocation": "ingest/_types/Processors.ts#L276-L291" }, { "inherits": { @@ -125720,6 +125727,7 @@ }, "properties": [ { + "description": "The field to get the base64 encoded field from.", "name": "field", "required": true, "type": { @@ -125731,8 +125739,10 @@ } }, { + "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -125742,8 +125752,10 @@ } }, { + "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", "name": "indexed_chars", "required": false, + "serverDefault": 100000, "type": { "kind": "instance_of", "type": { @@ -125753,8 +125765,10 @@ } }, { + "description": "Field name from which you can overwrite the number of chars being used for extraction.", "name": "indexed_chars_field", "required": false, + "serverDefault": "null", "type": { "kind": "instance_of", "type": { @@ -125764,6 +125778,7 @@ } }, { + "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", "name": "properties", "required": false, "type": { @@ -125778,8 +125793,10 @@ } }, { + "description": "The field that will hold the attachment information.", "name": "target_field", "required": false, + "serverDefault": "attachment", "type": { "kind": "instance_of", "type": { @@ -125789,6 +125806,7 @@ } }, { + "description": "Field containing the name of the resource to decode.\nIf specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.", "name": "resource_name", "required": false, "type": { @@ -125800,7 +125818,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L96-L104" + "specLocation": "ingest/_types/Processors.ts#L293-L329" }, { "inherits": { @@ -125816,6 +125834,7 @@ }, "properties": [ { + "description": "The field to convert.", "name": "field", "required": true, "type": { @@ -125827,8 +125846,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -125838,8 +125859,10 @@ } }, { + "description": "The field to assign the converted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -125849,7 +125872,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L123-L127" + "specLocation": "ingest/_types/Processors.ts#L384-L399" }, { "inherits": { @@ -125865,6 +125888,7 @@ }, "properties": [ { + "description": "The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`).", "name": "error_distance", "required": true, "type": { @@ -125876,6 +125900,7 @@ } }, { + "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.", "name": "field", "required": true, "type": { @@ -125887,8 +125912,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -125898,6 +125925,7 @@ } }, { + "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.", "name": "shape_type", "required": true, "type": { @@ -125909,6 +125937,7 @@ } }, { + "description": "The field to assign the polygon shape to, by default `field` is updated in-place.", "name": "target_field", "required": false, "type": { @@ -125920,7 +125949,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L129-L135" + "specLocation": "ingest/_types/Processors.ts#L401-L423" }, { "inherits": { @@ -125936,6 +125965,7 @@ }, "properties": [ { + "description": "The field whose value is to be converted.", "name": "field", "required": true, "type": { @@ -125947,8 +125977,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -125958,8 +125990,10 @@ } }, { + "description": "The field to assign the converted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -125969,6 +126003,7 @@ } }, { + "description": "The type to convert the existing value to.", "name": "type", "required": true, "type": { @@ -125980,7 +126015,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L147-L152" + "specLocation": "ingest/_types/Processors.ts#L435-L454" }, { "kind": "enum", @@ -126011,7 +126046,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L137-L145" + "specLocation": "ingest/_types/Processors.ts#L425-L433" }, { "inherits": { @@ -126027,6 +126062,7 @@ }, "properties": [ { + "description": "Value used to fill empty fields, empty fields will be skipped if this is not provided.\nEmpty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", "name": "empty_value", "required": false, "type": { @@ -126034,6 +126070,7 @@ } }, { + "description": "The field to extract data from.", "name": "field", "required": true, "type": { @@ -126045,6 +126082,7 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, "type": { @@ -126056,8 +126094,10 @@ } }, { + "description": "Quote used in CSV, has to be single character string.", "name": "quote", "required": false, + "serverDefault": "\"", "type": { "kind": "instance_of", "type": { @@ -126067,8 +126107,10 @@ } }, { + "description": "Separator used in CSV, has to be single character string.", "name": "separator", "required": false, + "serverDefault": ",", "type": { "kind": "instance_of", "type": { @@ -126078,6 +126120,7 @@ } }, { + "description": "The array of fields to assign extracted values to.", "name": "target_fields", "required": true, "type": { @@ -126089,6 +126132,7 @@ } }, { + "description": "Trim whitespaces in unquoted fields.", "name": "trim", "required": false, "type": { @@ -126100,7 +126144,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L154-L162" + "specLocation": "ingest/_types/Processors.ts#L456-L488" }, { "inherits": { @@ -126116,6 +126160,7 @@ }, "properties": [ { + "description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", "name": "date_formats", "required": true, "type": { @@ -126142,6 +126187,7 @@ } }, { + "description": "The field to get the date or timestamp from.", "name": "field", "required": true, "type": { @@ -126153,8 +126199,10 @@ } }, { + "description": "The format to be used when printing the parsed date into the index name.\nA valid java time pattern is expected here.\nSupports template snippets.", "name": "index_name_format", "required": false, + "serverDefault": "yyyy-MM-dd", "type": { "kind": "instance_of", "type": { @@ -126164,6 +126212,7 @@ } }, { + "description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.", "name": "index_name_prefix", "required": false, "type": { @@ -126175,8 +126224,10 @@ } }, { + "description": "The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.", "name": "locale", "required": false, + "serverDefault": "ENGLISH", "type": { "kind": "instance_of", "type": { @@ -126186,8 +126237,10 @@ } }, { + "description": "The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.", "name": "timezone", "required": false, + "serverDefault": "UTC", "type": { "kind": "instance_of", "type": { @@ -126197,7 +126250,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L164-L177" + "specLocation": "ingest/_types/Processors.ts#L490-L528" }, { "inherits": { @@ -126213,6 +126266,7 @@ }, "properties": [ { + "description": "The field to get the date from.", "name": "field", "required": true, "type": { @@ -126224,6 +126278,7 @@ } }, { + "description": "An array of the expected date formats.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", "name": "formats", "required": true, "type": { @@ -126238,8 +126293,10 @@ } }, { + "description": "The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets.", "name": "locale", "required": false, + "serverDefault": "ENGLISH", "type": { "kind": "instance_of", "type": { @@ -126249,8 +126306,10 @@ } }, { + "description": "The field that will hold the parsed date.", "name": "target_field", "required": false, + "serverDefault": "`@timestamp`", "type": { "kind": "instance_of", "type": { @@ -126260,8 +126319,10 @@ } }, { + "description": "The timezone to use when parsing the date.\nSupports template snippets.", "name": "timezone", "required": false, + "serverDefault": "UTC", "type": { "kind": "instance_of", "type": { @@ -126271,7 +126332,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L179-L185" + "specLocation": "ingest/_types/Processors.ts#L530-L557" }, { "inherits": { @@ -126287,8 +126348,10 @@ }, "properties": [ { + "description": "The character(s) that separate the appended fields.", "name": "append_separator", "required": false, + "serverDefault": "\"\"", "type": { "kind": "instance_of", "type": { @@ -126298,6 +126361,7 @@ } }, { + "description": "The field to dissect.", "name": "field", "required": true, "type": { @@ -126309,8 +126373,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126320,6 +126386,7 @@ } }, { + "description": "The pattern to apply to the field.", "name": "pattern", "required": true, "type": { @@ -126331,7 +126398,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L187-L192" + "specLocation": "ingest/_types/Processors.ts#L559-L578" }, { "inherits": { @@ -126347,6 +126414,7 @@ }, "properties": [ { + "description": "The field to expand into an object field.\nIf set to `*`, all top-level fields will be expanded.", "name": "field", "required": true, "type": { @@ -126358,6 +126426,7 @@ } }, { + "description": "The field that contains the field to expand.\nOnly required if the field to expand is part another object field, because the `field` option can only understand leaf fields.", "name": "path", "required": false, "type": { @@ -126369,7 +126438,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L194-L197" + "specLocation": "ingest/_types/Processors.ts#L580-L591" }, { "inherits": { @@ -126384,7 +126453,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L199-L199" + "specLocation": "ingest/_types/Processors.ts#L593-L593" }, { "inherits": { @@ -126400,6 +126469,7 @@ }, "properties": [ { + "description": "The field in the input document that matches the policies match_field used to retrieve the enrichment data.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -126411,8 +126481,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126422,8 +126494,10 @@ } }, { + "description": "The maximum number of matched documents to include under the configured target field.\nThe `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.\nIn order to avoid documents getting too large, the maximum allowed value is 128.", "name": "max_matches", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -126433,8 +126507,10 @@ } }, { + "description": "If processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.", "name": "override", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -126444,6 +126520,7 @@ } }, { + "description": "The name of the enrich policy to use.", "name": "policy_name", "required": true, "type": { @@ -126455,8 +126532,10 @@ } }, { + "description": "A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.\nThis option is only used for `geo_match` enrich policy types.", "name": "shape_relation", "required": false, + "serverDefault": "INTERSECTS", "type": { "kind": "instance_of", "type": { @@ -126466,6 +126545,7 @@ } }, { + "description": "Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.\nSupports template snippets.", "name": "target_field", "required": true, "type": { @@ -126477,7 +126557,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L201-L209" + "specLocation": "ingest/_types/Processors.ts#L595-L634" }, { "inherits": { @@ -126493,6 +126573,7 @@ }, "properties": [ { + "description": "The error message thrown by the processor.\nSupports template snippets.", "name": "message", "required": true, "type": { @@ -126504,7 +126585,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L211-L213" + "specLocation": "ingest/_types/Processors.ts#L636-L642" }, { "inherits": { @@ -126520,6 +126601,7 @@ }, "properties": [ { + "description": "Field containing array or object values.", "name": "field", "required": true, "type": { @@ -126531,8 +126613,10 @@ } }, { + "description": "If `true`, the processor silently exits without changing the document if the `field` is `null` or missing.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126542,6 +126626,7 @@ } }, { + "description": "Ingest processor to run on each element.", "name": "processor", "required": true, "type": { @@ -126553,7 +126638,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L215-L219" + "specLocation": "ingest/_types/Processors.ts#L644-L658" }, { "inherits": { @@ -126569,8 +126654,10 @@ }, "properties": [ { + "description": "The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.", "name": "database_file", "required": false, + "serverDefault": "GeoLite2-City.mmdb", "type": { "kind": "instance_of", "type": { @@ -126580,6 +126667,7 @@ } }, { + "description": "The field to get the ip address from for the geographical lookup.", "name": "field", "required": true, "type": { @@ -126591,8 +126679,10 @@ } }, { + "description": "f `true` only first found geoip data will be returned, even if field contains array.", "name": "first_only", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -126602,8 +126692,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126613,6 +126705,7 @@ } }, { + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", "name": "properties", "required": false, "type": { @@ -126627,8 +126720,10 @@ } }, { + "description": "The field that will hold the geographical information looked up from the MaxMind database.", "name": "target_field", "required": false, + "serverDefault": "geoip", "type": { "kind": "instance_of", "type": { @@ -126638,7 +126733,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L106-L113" + "specLocation": "ingest/_types/Processors.ts#L331-L360" }, { "inherits": { @@ -126654,6 +126749,7 @@ }, "properties": [ { + "description": "The field to use for grok expression parsing.", "name": "field", "required": true, "type": { @@ -126665,8 +126761,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126676,6 +126774,7 @@ } }, { + "description": "A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.\nPatterns matching existing names will override the pre-existing definition.", "name": "pattern_definitions", "required": false, "type": { @@ -126698,6 +126797,7 @@ } }, { + "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", "name": "patterns", "required": true, "type": { @@ -126712,8 +126812,10 @@ } }, { + "description": "When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched.", "name": "trace_match", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126723,7 +126825,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L221-L227" + "specLocation": "ingest/_types/Processors.ts#L660-L685" }, { "inherits": { @@ -126739,6 +126841,7 @@ }, "properties": [ { + "description": "The field to apply the replacement to.", "name": "field", "required": true, "type": { @@ -126750,8 +126853,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -126761,6 +126866,7 @@ } }, { + "description": "The pattern to be replaced.", "name": "pattern", "required": true, "type": { @@ -126772,6 +126878,7 @@ } }, { + "description": "The string to replace the matching patterns with.", "name": "replacement", "required": true, "type": { @@ -126783,8 +126890,10 @@ } }, { + "description": "The field to assign the converted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -126794,7 +126903,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L229-L235" + "specLocation": "ingest/_types/Processors.ts#L687-L710" }, { "kind": "interface", @@ -126804,6 +126913,7 @@ }, "properties": [ { + "description": "Regression configuration for inference.", "name": "regression", "required": false, "type": { @@ -126815,6 +126925,7 @@ } }, { + "description": "Classification configuration for inference.", "name": "classification", "required": false, "type": { @@ -126826,7 +126937,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L244-L250", + "specLocation": "ingest/_types/Processors.ts#L733-L745", "variants": { "kind": "container" } @@ -126839,8 +126950,10 @@ }, "properties": [ { + "description": "Specifies the number of top class predictions to return.", "name": "num_top_classes", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -126850,8 +126963,10 @@ } }, { + "description": "Specifies the maximum number of feature importance values per document.", "name": "num_top_feature_importance_values", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -126861,8 +126976,10 @@ } }, { + "description": "The field that is added to incoming documents to contain the inference prediction.", "name": "results_field", "required": false, + "serverDefault": "_prediction", "type": { "kind": "instance_of", "type": { @@ -126872,8 +126989,10 @@ } }, { + "description": "Specifies the field to which the top classes are written.", "name": "top_classes_results_field", "required": false, + "serverDefault": "top_classes", "type": { "kind": "instance_of", "type": { @@ -126883,6 +127002,7 @@ } }, { + "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", "name": "prediction_field_type", "required": false, "type": { @@ -126894,7 +127014,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L257-L263" + "specLocation": "ingest/_types/Processors.ts#L760-L786" }, { "kind": "interface", @@ -126904,8 +127024,10 @@ }, "properties": [ { + "description": "The field that is added to incoming documents to contain the inference prediction.", "name": "results_field", "required": false, + "serverDefault": "_prediction", "type": { "kind": "instance_of", "type": { @@ -126915,8 +127037,10 @@ } }, { + "description": "Specifies the maximum number of feature importance values per document.", "name": "num_top_feature_importance_values", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -126926,7 +127050,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L252-L255" + "specLocation": "ingest/_types/Processors.ts#L747-L758" }, { "inherits": { @@ -126942,6 +127066,7 @@ }, "properties": [ { + "description": "The ID or alias for the trained model, or the ID of the deployment.", "name": "model_id", "required": true, "type": { @@ -126953,8 +127078,10 @@ } }, { + "description": "Field added to incoming documents to contain results objects.", "name": "target_field", "required": false, + "serverDefault": "ml.inference.", "type": { "kind": "instance_of", "type": { @@ -126964,6 +127091,7 @@ } }, { + "description": "Maps the document field names to the known field names of the model.\nThis mapping takes precedence over any default mappings provided in the model configuration.", "name": "field_map", "required": false, "type": { @@ -126982,6 +127110,7 @@ } }, { + "description": "Contains the inference type and its options.", "name": "inference_config", "required": false, "type": { @@ -126993,7 +127122,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L237-L242" + "specLocation": "ingest/_types/Processors.ts#L712-L731" }, { "inherits": { @@ -127009,6 +127138,7 @@ }, "properties": [ { + "description": "Field containing array values to join.", "name": "field", "required": true, "type": { @@ -127020,6 +127150,7 @@ } }, { + "description": "The separator character.", "name": "separator", "required": true, "type": { @@ -127031,8 +127162,10 @@ } }, { + "description": "The field to assign the joined value to, by default field is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -127042,7 +127175,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L265-L269" + "specLocation": "ingest/_types/Processors.ts#L788-L802" }, { "inherits": { @@ -127058,8 +127191,10 @@ }, "properties": [ { + "description": "Flag that forces the parsed JSON to be added at the top level of the document.\n`target_field` must not be set when this option is chosen.", "name": "add_to_root", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127069,6 +127204,7 @@ } }, { + "description": "When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.\nWhen set to `merge`, conflicting fields will be merged.\nOnly applicable `if add_to_root` is set to true.", "name": "add_to_root_conflict_strategy", "required": false, "type": { @@ -127080,8 +127216,10 @@ } }, { + "description": "When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.\nInstead, the last encountered value for any duplicate key wins.", "name": "allow_duplicate_keys", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127091,6 +127229,7 @@ } }, { + "description": "The field to be parsed.", "name": "field", "required": true, "type": { @@ -127102,8 +127241,10 @@ } }, { + "description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -127113,7 +127254,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L271-L277" + "specLocation": "ingest/_types/Processors.ts#L804-L833" }, { "kind": "enum", @@ -127131,7 +127272,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L279-L284" + "specLocation": "ingest/_types/Processors.ts#L835-L840" }, { "inherits": { @@ -127147,6 +127288,7 @@ }, "properties": [ { + "description": "List of keys to exclude from document.", "name": "exclude_keys", "required": false, "type": { @@ -127161,6 +127303,7 @@ } }, { + "description": "The field to be parsed.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -127172,6 +127315,7 @@ } }, { + "description": "Regex pattern to use for splitting key-value pairs.", "name": "field_split", "required": true, "type": { @@ -127183,8 +127327,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127194,6 +127340,7 @@ } }, { + "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", "name": "include_keys", "required": false, "type": { @@ -127208,8 +127355,10 @@ } }, { + "description": "Prefix to be added to extracted keys.", "name": "prefix", "required": false, + "serverDefault": "null", "type": { "kind": "instance_of", "type": { @@ -127219,8 +127368,10 @@ } }, { + "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", "name": "strip_brackets", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127230,6 +127381,7 @@ } }, { + "description": "The field to insert the extracted keys into.\nDefaults to the root of the document.\nSupports template snippets.", "name": "target_field", "required": false, "type": { @@ -127241,6 +127393,7 @@ } }, { + "description": "String of characters to trim from extracted keys.", "name": "trim_key", "required": false, "type": { @@ -127252,6 +127405,7 @@ } }, { + "description": "String of characters to trim from extracted values.", "name": "trim_value", "required": false, "type": { @@ -127263,6 +127417,7 @@ } }, { + "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", "name": "value_split", "required": true, "type": { @@ -127274,7 +127429,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L286-L298" + "specLocation": "ingest/_types/Processors.ts#L842-L894" }, { "inherits": { @@ -127290,6 +127445,7 @@ }, "properties": [ { + "description": "The field to make lowercase.", "name": "field", "required": true, "type": { @@ -127301,8 +127457,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127312,8 +127470,10 @@ } }, { + "description": "The field to assign the converted value to, by default field is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -127323,7 +127483,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L300-L304" + "specLocation": "ingest/_types/Processors.ts#L896-L911" }, { "kind": "interface", @@ -127333,6 +127493,7 @@ }, "properties": [ { + "description": "Description of the ingest pipeline.", "name": "description", "required": false, "type": { @@ -127344,6 +127505,7 @@ } }, { + "description": "Processors to run immediately after a processor failure.", "name": "on_failure", "required": false, "type": { @@ -127358,6 +127520,7 @@ } }, { + "description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.", "name": "processors", "required": false, "type": { @@ -127372,6 +127535,7 @@ } }, { + "description": "Version number used by external systems to track ingest pipelines.", "name": "version", "required": false, "type": { @@ -127383,7 +127547,7 @@ } } ], - "specLocation": "ingest/_types/Pipeline.ts#L23-L28" + "specLocation": "ingest/_types/Pipeline.ts#L23-L41" }, { "kind": "interface", @@ -127393,6 +127557,7 @@ }, "properties": [ { + "description": "Description of the ingest pipeline.", "name": "description", "required": false, "type": { @@ -127404,6 +127569,7 @@ } }, { + "description": "Version number used by external systems to track ingest pipelines.", "name": "version", "required": false, "type": { @@ -127415,6 +127581,7 @@ } }, { + "description": "Processors used to perform transformations on documents before indexing.\nProcessors run sequentially in the order specified.", "name": "processors", "required": true, "type": { @@ -127429,7 +127596,7 @@ } } ], - "specLocation": "ingest/_types/Pipeline.ts#L44-L48" + "specLocation": "ingest/_types/Pipeline.ts#L57-L71" }, { "inherits": { @@ -127445,6 +127612,7 @@ }, "properties": [ { + "description": "The name of the pipeline to execute.\nSupports template snippets.", "name": "name", "required": true, "type": { @@ -127456,8 +127624,10 @@ } }, { + "description": "Whether to ignore missing pipelines instead of failing.", "name": "ignore_missing_pipeline", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127467,7 +127637,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L306-L309" + "specLocation": "ingest/_types/Processors.ts#L913-L924" }, { "kind": "interface", @@ -127477,6 +127647,7 @@ }, "properties": [ { + "description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.", "name": "description", "required": false, "type": { @@ -127488,6 +127659,7 @@ } }, { + "description": "Conditionally execute the processor.", "name": "if", "required": false, "type": { @@ -127499,6 +127671,7 @@ } }, { + "description": "Ignore failures for the processor.", "name": "ignore_failure", "required": false, "type": { @@ -127510,6 +127683,7 @@ } }, { + "description": "Handle failures for the processor.", "name": "on_failure", "required": false, "type": { @@ -127524,6 +127698,7 @@ } }, { + "description": "Identifier for the processor.\nUseful for debugging and metrics.", "name": "tag", "required": false, "type": { @@ -127535,7 +127710,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L69-L75" + "specLocation": "ingest/_types/Processors.ts#L238-L261" }, { "kind": "interface", @@ -127545,6 +127720,9 @@ }, "properties": [ { + "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", + "docId": "attachment", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html", "name": "attachment", "required": false, "type": { @@ -127556,6 +127734,9 @@ } }, { + "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", + "docId": "append-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html", "name": "append", "required": false, "type": { @@ -127567,6 +127748,9 @@ } }, { + "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", + "docId": "csv-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/csv-processor.html", "name": "csv", "required": false, "type": { @@ -127578,6 +127762,9 @@ } }, { + "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", + "docId": "convert-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/convert-processor.html", "name": "convert", "required": false, "type": { @@ -127589,6 +127776,9 @@ } }, { + "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", + "docId": "data-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html", "name": "date", "required": false, "type": { @@ -127600,6 +127790,9 @@ } }, { + "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", + "docId": "date-index-name-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html", "name": "date_index_name", "required": false, "type": { @@ -127611,6 +127804,9 @@ } }, { + "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", + "docId": "dot-expand-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dot-expand-processor.html", "name": "dot_expander", "required": false, "type": { @@ -127622,6 +127818,9 @@ } }, { + "description": "The `enrich` processor can enrich documents with data from another index.", + "docId": "enrich-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-processor.html", "name": "enrich", "required": false, "type": { @@ -127633,6 +127832,9 @@ } }, { + "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", + "docId": "fail-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fail-processor.html", "name": "fail", "required": false, "type": { @@ -127644,6 +127846,9 @@ } }, { + "description": "Runs an ingest processor on each element of an array or object.", + "docId": "foreach-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/foreach-processor.html", "name": "foreach", "required": false, "type": { @@ -127655,6 +127860,9 @@ } }, { + "description": "Converts a JSON string into a structured JSON object.", + "docId": "json-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/json-processor.html", "name": "json", "required": false, "type": { @@ -127666,6 +127874,9 @@ } }, { + "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", + "docId": "user-agent-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html", "name": "user_agent", "required": false, "type": { @@ -127677,6 +127888,9 @@ } }, { + "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", + "docId": "kv-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv-processor.html", "name": "kv", "required": false, "type": { @@ -127688,6 +127902,9 @@ } }, { + "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", + "docId": "geoip-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "geoip", "required": false, "type": { @@ -127699,6 +127916,9 @@ } }, { + "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "docId": "grok-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "grok", "required": false, "type": { @@ -127710,6 +127930,9 @@ } }, { + "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", + "docId": "gsub-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html", "name": "gsub", "required": false, "type": { @@ -127721,6 +127944,9 @@ } }, { + "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", + "docId": "join-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/join-processor.html", "name": "join", "required": false, "type": { @@ -127732,6 +127958,9 @@ } }, { + "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "docId": "lowercase-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html", "name": "lowercase", "required": false, "type": { @@ -127743,6 +127972,9 @@ } }, { + "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", + "docId": "remove-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remove-processor.html", "name": "remove", "required": false, "type": { @@ -127754,6 +127986,9 @@ } }, { + "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", + "docId": "rename-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rename-processor.html", "name": "rename", "required": false, "type": { @@ -127765,6 +128000,9 @@ } }, { + "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", + "docId": "script-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/script-processor.html", "name": "script", "required": false, "type": { @@ -127776,6 +128014,9 @@ } }, { + "description": "Sets one field and associates it with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", + "docId": "set-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html", "name": "set", "required": false, "type": { @@ -127787,6 +128028,9 @@ } }, { + "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", + "docId": "sort-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html", "name": "sort", "required": false, "type": { @@ -127798,6 +128042,9 @@ } }, { + "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", + "docId": "split-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/split-processor.html", "name": "split", "required": false, "type": { @@ -127809,6 +128056,9 @@ } }, { + "description": "Trims whitespace from field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", + "docId": "trim-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html", "name": "trim", "required": false, "type": { @@ -127820,6 +128070,9 @@ } }, { + "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", + "docId": "uppercase-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/uppercase-processor.html", "name": "uppercase", "required": false, "type": { @@ -127831,6 +128084,9 @@ } }, { + "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", + "docId": "urldecode-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/urldecode-processor.html", "name": "urldecode", "required": false, "type": { @@ -127842,6 +128098,9 @@ } }, { + "description": "Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", + "docId": "bytes-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/bytes-processor.html", "name": "bytes", "required": false, "type": { @@ -127853,6 +128112,9 @@ } }, { + "description": "Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document.\nHowever unlike the Grok Processor, dissect does not use Regular Expressions.\nThis allows dissect’s syntax to be simple and for some cases faster than the Grok Processor.\nDissect matches a single text field against a defined pattern.", + "docId": "dissect-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", "name": "dissect", "required": false, "type": { @@ -127864,6 +128126,9 @@ } }, { + "description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.", + "docId": "ingest-node-set-security-user-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{banch}/ingest-node-set-security-user-processor.html", "name": "set_security_user", "required": false, "type": { @@ -127875,6 +128140,9 @@ } }, { + "description": "Executes another pipeline.", + "docId": "pipeline-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html", "name": "pipeline", "required": false, "type": { @@ -127886,6 +128154,9 @@ } }, { + "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", + "docId": "drop-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/drop-processor.html", "name": "drop", "required": false, "type": { @@ -127897,6 +128168,9 @@ } }, { + "description": "Converts circle definitions of shapes to regular polygons which approximate them.", + "docId": "ingest-circle-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-circle-processor.html", "name": "circle", "required": false, "type": { @@ -127908,6 +128182,9 @@ } }, { + "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", + "docId": "inference-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inference-processor.html", "name": "inference", "required": false, "type": { @@ -127919,7 +128196,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L28-L67", + "specLocation": "ingest/_types/Processors.ts#L28-L236", "variants": { "kind": "container", "nonExhaustive": true @@ -127939,6 +128216,7 @@ }, "properties": [ { + "description": "Fields to be removed. Supports template snippets.", "name": "field", "required": true, "type": { @@ -127950,8 +128228,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127961,7 +128241,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L311-L314" + "specLocation": "ingest/_types/Processors.ts#L926-L936" }, { "inherits": { @@ -127977,6 +128257,7 @@ }, "properties": [ { + "description": "The field to be renamed.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -127988,8 +128269,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -127999,6 +128282,7 @@ } }, { + "description": "The new name of the field.\nSupports template snippets.", "name": "target_field", "required": true, "type": { @@ -128010,7 +128294,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L316-L320" + "specLocation": "ingest/_types/Processors.ts#L938-L954" }, { "inherits": { @@ -128026,6 +128310,7 @@ }, "properties": [ { + "description": "The origin field which will be copied to `field`, cannot set `value` simultaneously.\nSupported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.", "name": "copy_from", "required": false, "type": { @@ -128037,6 +128322,7 @@ } }, { + "description": "The field to insert, upsert, or update.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -128048,8 +128334,10 @@ } }, { + "description": "If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document.", "name": "ignore_empty_value", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128059,6 +128347,7 @@ } }, { + "description": "The media type for encoding `value`.\nApplies only when value is a template snippet.\nMust be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.", "name": "media_type", "required": false, "type": { @@ -128070,8 +128359,10 @@ } }, { + "description": "If `true` processor will update fields with pre-existing non-null-valued field.\nWhen set to `false`, such fields will not be touched.", "name": "override", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -128081,6 +128372,7 @@ } }, { + "description": "The value to be set for the field.\nSupports template snippets.\nMay specify only one of `value` or `copy_from`.", "name": "value", "required": false, "type": { @@ -128088,7 +128380,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L329-L336" + "specLocation": "ingest/_types/Processors.ts#L978-L1012" }, { "inherits": { @@ -128104,6 +128396,7 @@ }, "properties": [ { + "description": "The field to store the user information into.", "name": "field", "required": true, "type": { @@ -128115,6 +128408,7 @@ } }, { + "description": "Controls what user related properties are added to the field.", "name": "properties", "required": false, "type": { @@ -128129,7 +128423,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L338-L341" + "specLocation": "ingest/_types/Processors.ts#L1014-L1023" }, { "kind": "enum", @@ -128145,7 +128439,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L343-L346" + "specLocation": "ingest/_types/Processors.ts#L1025-L1028" }, { "inherits": { @@ -128161,6 +128455,7 @@ }, "properties": [ { + "description": "The field to be sorted.", "name": "field", "required": true, "type": { @@ -128172,8 +128467,10 @@ } }, { + "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", "name": "order", "required": false, + "serverDefault": "\"asc\"", "type": { "kind": "instance_of", "type": { @@ -128183,6 +128480,7 @@ } }, { + "description": "The field to assign the sorted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, "type": { @@ -128194,7 +128492,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L348-L352" + "specLocation": "ingest/_types/Processors.ts#L1030-L1045" }, { "inherits": { @@ -128210,6 +128508,7 @@ }, "properties": [ { + "description": "The field to split.", "name": "field", "required": true, "type": { @@ -128221,8 +128520,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128232,8 +128533,10 @@ } }, { + "description": "Preserves empty trailing fields, if any.", "name": "preserve_trailing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128243,6 +128546,7 @@ } }, { + "description": "A regex which matches the separator, for example, `,` or `\\s+`.", "name": "separator", "required": true, "type": { @@ -128254,8 +128558,10 @@ } }, { + "description": "The field to assign the split value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -128265,7 +128571,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L354-L360" + "specLocation": "ingest/_types/Processors.ts#L1047-L1071" }, { "inherits": { @@ -128281,6 +128587,7 @@ }, "properties": [ { + "description": "The string-valued field to trim whitespace from.", "name": "field", "required": true, "type": { @@ -128292,8 +128599,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128303,8 +128612,10 @@ } }, { + "description": "The field to assign the trimmed value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -128314,7 +128625,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L362-L366" + "specLocation": "ingest/_types/Processors.ts#L1073-L1088" }, { "inherits": { @@ -128330,6 +128641,7 @@ }, "properties": [ { + "description": "The field to make uppercase.", "name": "field", "required": true, "type": { @@ -128341,8 +128653,10 @@ } }, { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128352,8 +128666,10 @@ } }, { + "description": "The field to assign the converted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -128363,7 +128679,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L368-L372" + "specLocation": "ingest/_types/Processors.ts#L1090-L1105" }, { "inherits": { @@ -128379,6 +128695,7 @@ }, "properties": [ { + "description": "The field to decode.", "name": "field", "required": true, "type": { @@ -128390,8 +128707,10 @@ } }, { - "name": "ignore_missing", + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "name": "ignre_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128401,8 +128720,10 @@ } }, { + "description": "The field to assign the converted value to, by default `field` is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -128412,7 +128733,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L374-L378" + "specLocation": "ingest/_types/Processors.ts#L1107-L1122" }, { "inherits": { @@ -128428,6 +128749,7 @@ }, "properties": [ { + "description": "The field containing the user agent string.", "name": "field", "required": true, "type": { @@ -128439,8 +128761,10 @@ } }, { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -128464,6 +128788,7 @@ } }, { + "description": "The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.", "name": "regex_file", "required": false, "type": { @@ -128475,8 +128800,10 @@ } }, { + "description": "The field that will be filled with the user agent details.", "name": "target_field", "required": false, + "serverDefault": "user_agent", "type": { "kind": "instance_of", "type": { @@ -128486,7 +128813,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L115-L121" + "specLocation": "ingest/_types/Processors.ts#L362-L382" }, { "kind": "enum", @@ -128526,7 +128853,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L77-L88" + "specLocation": "ingest/_types/Processors.ts#L263-L274" }, { "attachedBehaviors": [ @@ -128535,7 +128862,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a pipeline.", + "description": "Deletes one or more existing ingest pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -128549,7 +128876,7 @@ }, "path": [ { - "description": "Pipeline ID", + "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", "name": "id", "required": true, "type": { @@ -128563,9 +128890,10 @@ ], "query": [ { - "description": "Explicit operation timeout for connection to master node", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -128575,9 +128903,10 @@ } }, { - "description": "Explicit operation timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -128587,7 +128916,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L37" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L52" }, { "body": { @@ -128756,7 +129085,7 @@ "body": { "kind": "no_body" }, - "description": "Returns statistical information about geoip databases", + "description": "Gets download statistics for GeoIP2 databases used with the geoip processor.", "inherits": { "type": { "name": "RequestBase", @@ -128770,7 +129099,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L27" + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L29" }, { "body": { @@ -128827,7 +129156,7 @@ "body": { "kind": "no_body" }, - "description": "Returns a pipeline.", + "description": "Returns information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -128841,7 +129170,7 @@ }, "path": [ { - "description": "Comma separated list of pipeline ids. Wildcards supported", + "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", "name": "id", "required": false, "type": { @@ -128855,7 +129184,7 @@ ], "query": [ { - "description": "Explicit operation timeout for connection to master node", + "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -128881,7 +129210,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L39" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L50" }, { "body": { @@ -128919,7 +129248,7 @@ "body": { "kind": "no_body" }, - "description": "Returns a list of the built-in patterns.", + "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "inherits": { "type": { "name": "RequestBase", @@ -128933,7 +129262,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L27" + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L31" }, { "body": { @@ -129045,7 +129374,7 @@ } ] }, - "description": "Creates or updates a pipeline.", + "description": "Creates or updates an ingest pipeline.\nChanges made using this API take effect immediately.", "inherits": { "type": { "name": "RequestBase", @@ -129111,7 +129440,7 @@ } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L74" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L77" }, { "body": { @@ -129139,6 +129468,7 @@ }, "properties": [ { + "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.", "name": "_id", "required": false, "type": { @@ -129150,6 +129480,7 @@ } }, { + "description": "Name of the index containing the document.", "name": "_index", "required": false, "type": { @@ -129161,6 +129492,7 @@ } }, { + "description": "JSON body for the document.", "name": "_source", "required": true, "type": { @@ -129168,7 +129500,7 @@ } } ], - "specLocation": "ingest/simulate/types.ts#L41-L45" + "specLocation": "ingest/simulate/types.ts#L41-L55" }, { "attachedBehaviors": [ @@ -129206,6 +129538,7 @@ }, "properties": [ { + "description": "Unique identifier for the document. This ID must be unique within the `_index`.", "name": "_id", "required": true, "type": { @@ -129217,6 +129550,7 @@ } }, { + "description": "Name of the index containing the document.", "name": "_index", "required": true, "type": { @@ -129239,6 +129573,7 @@ } }, { + "description": "Value used to send the document to a specific primary shard.", "name": "_routing", "required": false, "type": { @@ -129250,6 +129585,7 @@ } }, { + "description": "JSON body for the document.", "name": "_source", "required": true, "type": { @@ -129268,6 +129604,7 @@ } }, { + "description": "", "name": "_version", "required": false, "type": { @@ -129299,7 +129636,7 @@ } } ], - "specLocation": "ingest/simulate/types.ts#L47-L60" + "specLocation": "ingest/simulate/types.ts#L57-L85" }, { "kind": "interface", @@ -129409,6 +129746,7 @@ "kind": "properties", "properties": [ { + "description": "Sample documents to test in the pipeline.", "name": "docs", "required": false, "type": { @@ -129423,6 +129761,7 @@ } }, { + "description": "Pipeline to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "name": "pipeline", "required": false, "type": { @@ -129435,7 +129774,7 @@ } ] }, - "description": "Allows to simulate a pipeline with example documents.", + "description": "Executes an ingest pipeline against a set of provided documents.", "inherits": { "type": { "name": "RequestBase", @@ -129449,7 +129788,7 @@ }, "path": [ { - "description": "Pipeline ID", + "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", "name": "id", "required": false, "type": { @@ -129463,7 +129802,7 @@ ], "query": [ { - "description": "Verbose mode. Display data output for each processor in executed pipeline", + "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "name": "verbose", "required": false, "type": { @@ -129475,7 +129814,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L41" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L57" }, { "body": { diff --git a/output/typescript/types.ts b/output/typescript/types.ts index ac22d089cc..3e8ac02ef1 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -11692,7 +11692,7 @@ export interface IngestUppercaseProcessor extends IngestProcessorBase { export interface IngestUrlDecodeProcessor extends IngestProcessorBase { field: Field - ignore_missing?: boolean + ignre_missing?: boolean target_field?: Field } diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 2f1a108ce9..56825b398d 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -1,23 +1,32 @@ +analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html +analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html +analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html +analysis-standard-analyzer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-standard-analyzer.html +analysis-tokenfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenfilters.html +analysis-tokenizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html +analysis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html +analyzer-anatomy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-date-math-index-names +append-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html async-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html +attachment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html autoscaling-delete-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html autoscaling-get-autoscaling-capacity,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html autoscaling-get-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-policy.html autoscaling-put-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html avoid-index-pattern-collisions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html#avoid-index-pattern-collisions -docs-bulk,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html +byte-units,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#byte-units +bytes-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/bytes-processor.html cat-alias,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html cat-allocation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html +cat-anomaly-detectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html cat-count,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html +cat-datafeeds,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html +cat-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html cat-fielddata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-fielddata.html cat-health,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-health.html -cat,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html cat-indices,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-indices.html cat-master,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-master.html -cat-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html -cat-datafeeds,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html -cat-anomaly-detectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html -cat-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html cat-nodeattrs,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html cat-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodes.html cat-pending-tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-pending-tasks.html @@ -27,65 +36,124 @@ cat-repositories,https://www.elastic.co/guide/en/elasticsearch/reference/{branch cat-segments,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html cat-shards,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html cat-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html -tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html cat-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html cat-thread-pool,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html +cat-trained-model,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html cat-transforms,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html +cat,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html ccr-delete-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html -ccr-put-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html +ccr-get-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html ccr-get-follow-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html ccr-get-follow-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html -ccr-post-forget-follower,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html -ccr-get-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html +ccr-get-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html ccr-pause-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-pause-auto-follow-pattern.html +ccr-post-forget-follower,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html ccr-post-pause-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html -ccr-put-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html -ccr-resume-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html ccr-post-resume-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-resume-follow.html -ccr-get-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html ccr-post-unfollow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html +ccr-put-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html +ccr-put-follow,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html +ccr-resume-auto-follow-pattern,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html +ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays +clean-up-snapshot-repo-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clean-up-snapshot-repo-api.html +clear-repositories-metering-archive-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html clear-scroll-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html -point-in-time-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html +clear-sql-cursor-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html cluster-allocation-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html -indices-component-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html -voting-config-exclusions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html cluster-get-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html cluster-health,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html cluster-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-info.html +cluster-name,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html#cluster-name +cluster-nodes-hot-threads,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html +cluster-nodes-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html +cluster-nodes-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html +cluster-nodes-usage,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html +cluster-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes cluster-pending,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-pending.html -cluster-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html cluster-remote-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html cluster-reroute,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-reroute.html cluster-state,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-state.html cluster-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-stats.html -cluster-nodes-hot-threads,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html -cluster-nodes-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html -cluster-nodes-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html -cluster-nodes-usage,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html -indices-downsample-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html -search-count,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-count.html -docs-index_,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html -modules-gateway-dangling-indices,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-gateway-dangling-indices.html -docs-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete.html +cluster-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html +cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html +common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html +convert-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/convert-processor.html +cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions +csv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/csv-processor.html +data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html +data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params +data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html +date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html +dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg +delete-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html +delete-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html +delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html +delete-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html +delete-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html +delete-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html +delete-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html +dissect-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html +distance-units,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#distance-units +docs-bulk,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html docs-delete-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete-by-query.html docs-delete-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete-by-query.html -modules-scripting,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-scripting.html -delete-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html -execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html -get-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html -put-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html +docs-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete.html +docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html +docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html +docs-index_,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html +docs-multi-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-get.html +docs-multi-termvectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-termvectors.html +docs-reindex,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-reindex.html +docs-termvectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-termvectors.html +docs-update-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update-by-query.html +docs-update-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update-by-query.html +docs-update,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update.html +document-input-parameters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html#_document_input_parameters +dot-expand-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dot-expand-processor.html +drop-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/drop-processor.html +enrich-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-processor.html enrich-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html eql-async-search-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html eql-async-search-status-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html +eql-basic-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-basic-syntax eql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html -docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html -search-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html +eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences +eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html +eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html +evaluate-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html +execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html +expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err +explain-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/explain-dfanalytics.html +fail-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fail-processor.html +field-and-document-access-control,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html +field-usage-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-usage-stats.html +find-structure,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-structure.html +foreach-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/foreach-processor.html +fuzziness,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness +gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy +geo-shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geo-shape.html +geoip-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html +geoip-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-stats-api.html +get-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-api.html +get-async-sql-search-status-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-status-api.html +get-basic-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-basic-status.html +get-dfanalytics-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics-stats.html +get-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics.html +get-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html get-features-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-features-api.html -modules-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-snapshots.html -search-field-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-field-caps.html get-global-checkpoints,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-global-checkpoints.html -painless-contexts,https://www.elastic.co/guide/en/elasticsearch/painless/{branch}/painless-contexts.html +get-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html +get-ml-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-info.html +get-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html +get-repositories-metering-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-repositories-metering-api.html +get-trained-models-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html +get-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html +get-transform-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html +get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html +get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html +grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html +gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html ilm-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html ilm-explain-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-explain-lifecycle.html ilm-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-lifecycle.html @@ -97,28 +165,33 @@ ilm-remove-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branc ilm-retry-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-retry-policy.html ilm-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-start.html ilm-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-stop.html +important-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html index-modules-blocks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-blocks.html +index-modules-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings +index-modules-slowlog-slowlog,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log +index-modules,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html +index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index.html +indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html +indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html indices-clone-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html indices-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html -indices-open-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-open-close.html +indices-component-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html +indices-create-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html indices-create-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html -data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html indices-delete-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-index.html -indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html -indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates.html indices-disk-usage,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html +indices-downsample-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html indices-exists,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-exists.html -field-usage-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-usage-stats.html indices-flush,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html indices-forcemerge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-forcemerge.html -indices-get-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-index.html indices-get-field-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-field-mapping.html +indices-get-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-index.html indices-get-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-mapping.html indices-get-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-settings.html +indices-open-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-open-close.html indices-put-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-put-mapping.html -indices-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-update-settings.html indices-recovery,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-recovery.html indices-refresh,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-refresh.html indices-reload-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-reload-analyzers.html @@ -129,293 +202,115 @@ indices-shards-stores,https://www.elastic.co/guide/en/elasticsearch/reference/{b indices-shrink-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html indices-split-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html indices-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-stats.html -unfreeze-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/unfreeze-index-api.html -search-validate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-validate.html -index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index.html -delete-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html -geoip-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-stats-api.html -get-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html -grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html -put-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-pipeline-api.html -simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html -search-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html -delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html -get-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html -get-basic-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-basic-status.html -get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html -update-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-license.html -start-basic,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-basic.html -start-trial,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trial.html +indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates.html +indices-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-update-settings.html +infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model-deployment.html +inference-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inference-processor.html +info-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/info-api.html +ingest,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html +ingest-circle-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-circle-processor.html +ingest-node-set-security-user-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{banch}/ingest-node-set-security-user-processor.html +inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html +join-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/join-processor.html +json-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/json-processor.html +k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-precision +k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall +kv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv-processor.html logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html -docs-multi-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-get.html +lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html +mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html +mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html +mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html +mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html +mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html +mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html +mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank migration-api-deprecation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-deprecation.html migration-api-feature-upgrade,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-feature-upgrade.html +ml-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-apis.html +ml-classification,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-classification.html ml-close-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html -ml-delete-calendar,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html ml-delete-calendar-event,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html ml-delete-calendar-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html -ml-delete-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html +ml-delete-calendar,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html ml-delete-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html +ml-delete-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html ml-delete-expired-data,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-expired-data.html ml-delete-filter,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-filter.html ml-delete-forecast,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-forecast.html ml-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-job.html ml-delete-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-snapshot.html -delete-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html -delete-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html -ml-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-apis.html -evaluate-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html -explain-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/explain-dfanalytics.html +ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html ml-flush-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-flush-job.html ml-forecast,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-forecast.html ml-get-bucket,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-bucket.html ml-get-calendar-event,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar-event.html ml-get-calendar,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar.html ml-get-category,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-category.html -get-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics.html -get-dfanalytics-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics-stats.html ml-get-datafeed-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed-stats.html ml-get-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed.html ml-get-filter,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-filter.html ml-get-influencer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-influencer.html +ml-get-job-model-snapshot-upgrade-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-model-snapshot-upgrade-stats.html ml-get-job-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-stats.html ml-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job.html -ml-get-job-model-snapshot-upgrade-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-model-snapshot-upgrade-stats.html -ml-get-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-snapshot.html ml-get-overall-buckets,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-overall-buckets.html ml-get-record,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-record.html -get-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html -get-trained-models-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html -infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model-deployment.html -get-ml-info,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-info.html +ml-get-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-snapshot.html +ml-jobs,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-jobs.html +ml-model-snapshots,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-ad-run-jobs.html#ml-ad-model-snapshots ml-open-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-open-job.html ml-post-calendar-event,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-calendar-event.html ml-post-data,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-data.html -preview-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html ml-preview-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-preview-datafeed.html -ml-put-calendar,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar.html ml-put-calendar-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar-job.html -put-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html +ml-put-calendar,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar.html ml-put-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-datafeed.html ml-put-filter,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-filter.html ml-put-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html -put-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models.html -put-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html -put-trained-model-definition-part,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html -put-trained-model-vocabulary,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html +ml-regression-loss,https://www.elastic.co/guide/en/machine-learning/{branch}/dfa-regression-lossfunction.html +ml-regression,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-regression.html ml-reset-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-reset-job.html ml-revert-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-revert-snapshot.html ml-set-upgrade-mode,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-set-upgrade-mode.html -start-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-dfanalytics.html +ml-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html ml-start-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-start-datafeed.html -start-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trained-model-deployment.html -stop-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-dfanalytics.html ml-stop-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-stop-datafeed.html -stop-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html -update-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html ml-update-datafeed,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-datafeed.html ml-update-filter,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-filter.html ml-update-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-job.html ml-update-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-snapshot.html ml-upgrade-job-model-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-upgrade-job-model-snapshot.html -ml-jobs,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-jobs.html +modules-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cluster.html +modules-cross-cluster-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html +modules-discovery-hosts-providers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-discovery-hosts-providers.html +modules-fielddata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-fielddata.html +modules-gateway-dangling-indices,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-gateway-dangling-indices.html +modules-node,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html +modules-remote-clusters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-remote-clusters.html +modules-scripting,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-scripting.html +modules-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-snapshots.html monitor-elasticsearch-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/monitor-elasticsearch-cluster.html -search-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html -search-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html -docs-multi-termvectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-termvectors.html -clear-repositories-metering-archive-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html -get-repositories-metering-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-repositories-metering-api.html -secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html -search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html -docs-reindex,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-reindex.html -render-search-template-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html -rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html -rollup-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-job.html -rollup-get-rollup-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-caps.html -rollup-get-rollup-index-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-index-caps.html -rollup-put-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-put-job.html -xpack-rollup,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-rollup.html -rollup-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-search.html -rollup-start-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-start-job.html -rollup-stop-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-stop-job.html +multi-fields,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-fields.html +node-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html#node-roles +paginate-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html +painless-contexts,https://www.elastic.co/guide/en/elasticsearch/painless/{branch}/painless-contexts.html painless-execute-api,https://www.elastic.co/guide/en/elasticsearch/painless/{branch}/painless-execute-api.html -search-request-body,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-request-body.html -search-vector-tile-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html -search-shards,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-shards.html -search-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html -searchable-snapshots-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-apis.html -searchable-snapshots-api-mount-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html -security-api-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-authenticate.html -security-api-change-password,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-change-password.html -security-api-clear-api-key-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-api-key-cache.html -security-api-clear-privilege-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-privilege-cache.html -security-api-clear-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-cache.html -security-api-clear-role-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-role-cache.html -security-api-clear-service-token-caches,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-service-token-caches.html -security-api-create-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html -security-api-create-service-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-service-token.html -security-api-delete-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-privilege.html -security-api-delete-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role.html -security-api-delete-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role-mapping.html -security-api-delete-service-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-service-token.html -security-api-delete-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-user.html -security-api-disable-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-disable-user.html -security-api-enable-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-enable-user.html -security-api-kibana-enrollment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-kibana-enrollment.html -security-api-node-enrollment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-node-enrollment.html -security-api-get-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-api-key.html -security-api-get-builtin-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-builtin-privileges.html -security-api-get-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-privileges.html -security-api-get-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role.html -security-api-get-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role-mapping.html -security-api-get-service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-accounts.html -security-api-get-service-credentials,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-credentials.html -security-api-get-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-token.html -security-api-get-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user.html -security-api-get-user-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user-privileges.html -security-api-grant-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-grant-api-key.html -security-api-has-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-has-privileges.html -security-api-invalidate-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-api-key.html -security-api-invalidate-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-token.html -security-api-put-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-privileges.html -security-api-put-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html -security-api-put-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role-mapping.html -security-api-put-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-user.html -security-api-query-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-query-api-key.html -security-api-saml-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-authenticate.html -security-api-saml-complete-logout,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-complete-logout.html -security-api-saml-invalidate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-invalidate.html -security-api-saml-logout,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-logout.html -security-api-saml-prepare-authentication,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-prepare-authentication.html -security-api-saml-sp-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-sp-metadata.html -slm-api-delete-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-delete-policy.html -slm-api-execute-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-lifecycle.html -slm-api-execute-retention,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-retention.html -slm-api-get-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-policy.html -slm-api-get-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-stats.html -slm-api-get-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-status.html -slm-api-put-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-put-policy.html -slm-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-start.html -slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html -clean-up-snapshot-repo-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clean-up-snapshot-repo-api.html -clear-sql-cursor-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html -delete-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html -get-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-api.html -get-async-sql-search-status-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-status-api.html -sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-search-api.html -sql-translate-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-translate-api.html -security-api-ssl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-ssl.html -search-terms-enum,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-terms-enum.html -docs-termvectors,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-termvectors.html -find-structure,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-structure.html -delete-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html -get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html -get-transform-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html +pipeline-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html +point-in-time-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html +preview-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html preview-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html +put-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html +put-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html +put-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-pipeline-api.html +put-trained-model-definition-part,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html +put-trained-model-vocabulary,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html +put-trained-models-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html +put-trained-models,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models.html put-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-transform.html -reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html -start-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html -stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html -update-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html -upgrade-transforms,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html -docs-update,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update.html -docs-update-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update-by-query.html -docs-update-by-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update-by-query.html -watcher-api-ack-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-ack-watch.html -watcher-api-activate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-activate-watch.html -watcher-api-deactivate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-deactivate-watch.html -watcher-api-delete-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-delete-watch.html -watcher-api-execute-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-execute-watch.html -watcher-api-get-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-get-watch.html -watcher-api-put-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-put-watch.html -watcher-api-query-watches,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-query-watches.html -watcher-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-start.html -watcher-api-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stats.html -watcher-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stop.html -info-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/info-api.html -usage-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/usage-api.html -docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html -mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html -modules-cross-cluster-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html -search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html -paginate-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html -sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html -query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html -query-dsl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html -common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html -indices-create-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html -mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html -query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html -query-dsl-multi-term-rewrite,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html -modules-node,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html -search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html -search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html -search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html -search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html -search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#buckets-path-syntax -ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html -analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html -analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html -analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html -analysis-standard-analyzer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-standard-analyzer.html -analysis-tokenfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenfilters.html -analysis-tokenizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html -geo-shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geo-shape.html -shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html -mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html -query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html -modules-remote-clusters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-remote-clusters.html -modules-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cluster.html -modules-fielddata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-fielddata.html -mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html -analyzer-anatomy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html -modules-discovery-hosts-providers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-discovery-hosts-providers.html -important-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html -cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html -eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html -eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html -index-modules,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html -ml-classification,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-classification.html -ml-regression,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-regression.html -ml-regression-loss,https://www.elastic.co/guide/en/machine-learning/{branch}/dfa-regression-lossfunction.html -ml-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html -ml-model-snapshots,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-ad-run-jobs.html#ml-ad-model-snapshots -indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html -field-and-document-access-control,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html -run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html -sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html -sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html -cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions -runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html -mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html -realtime,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime -routing,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing -ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays -k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-precision -k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall -mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank -dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg -expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err -scroll-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results -document-input-parameters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html#_document_input_parameters -data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params -byte-units,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#byte-units -node-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html#node-roles -cluster-name,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html#cluster-name -cluster-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes -sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker -eql-basic-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-basic-syntax -time-value,https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java -supported-flags,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html#supported-flags -eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences -index-modules-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings -templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query -mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html -index-modules-slowlog-slowlog,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log -multi-fields,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-fields.html query-dsl-bool-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html query-dsl-boosting-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html query-dsl-combined-fields-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html @@ -424,27 +319,26 @@ query-dsl-dis-max-query,https://www.elastic.co/guide/en/elasticsearch/reference/ query-dsl-distance-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html query-dsl-exists-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html query-dsl-function-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html -fuzziness,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness query-dsl-fuzzy-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html query-dsl-geo-bounding-box-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html query-dsl-geo-distance-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html -distance-units,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#distance-units query-dsl-geo-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html query-dsl-has-child-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html -inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html query-dsl-has-parent-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html query-dsl-ids-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html query-dsl-intervals-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html -analysis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html -query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html -query-dsl-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html query-dsl-match-all-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html query-dsl-match-bool-prefix-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html query-dsl-match-none-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query -query-dsl-match-query-phrase,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html query-dsl-match-query-phrase-prefix,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html +query-dsl-match-query-phrase,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html +query-dsl-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html +query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html +query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html +query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html query-dsl-multi-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html +query-dsl-multi-term-rewrite,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html query-dsl-nested-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html query-dsl-parent-id-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html query-dsl-percolate-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html @@ -454,11 +348,11 @@ query-dsl-query-string-query,https://www.elastic.co/guide/en/elasticsearch/refer query-dsl-range-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html query-dsl-rank-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html query-dsl-regexp-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html -regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html query-dsl-script-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html query-dsl-script-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html query-dsl-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html +query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html query-dsl-span-containing-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html query-dsl-span-field-masking-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html query-dsl-span-first-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html @@ -474,24 +368,164 @@ query-dsl-terms-set-query,https://www.elastic.co/guide/en/elasticsearch/referenc query-dsl-text-expansion-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html +query-dsl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html +realtime,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime +regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html +remove-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remove-processor.html +rename-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rename-processor.html +render-search-template-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html +reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html +rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html +rollup-get-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-job.html +rollup-get-rollup-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-caps.html +rollup-get-rollup-index-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-index-caps.html +rollup-put-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-put-job.html +rollup-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-search.html +rollup-start-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-start-job.html +rollup-stop-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-stop-job.html +routing,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing +run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html +runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html +script-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/script-processor.html +scroll-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html +search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html +search-aggregations-bucket-children-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html +search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html +search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html +search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html +search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html +search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html +search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html +search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html +search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html search-aggregations-metrics-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html -search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html -gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy search-aggregations-metrics-boxplot-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html +search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html +search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html +search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html +search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#buckets-path-syntax search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html -search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html -search-aggregations-bucket-children-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html -search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html -search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html -search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html -search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html search-aggregations-pipeline-extended-stats-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html -search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html -search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html \ No newline at end of file +search-count,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-count.html +search-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html +search-field-caps,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-field-caps.html +search-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html +search-multi-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html +search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html +search-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html +search-request-body,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-request-body.html +search-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html +search-shards,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-shards.html +search-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html +search-terms-enum,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-terms-enum.html +search-validate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-validate.html +search-vector-tile-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html +searchable-snapshots-api-mount-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html +searchable-snapshots-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-apis.html +secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/secure-settings.html +security-api-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-authenticate.html +security-api-change-password,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-change-password.html +security-api-clear-api-key-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-api-key-cache.html +security-api-clear-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-cache.html +security-api-clear-privilege-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-privilege-cache.html +security-api-clear-role-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-role-cache.html +security-api-clear-service-token-caches,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-service-token-caches.html +security-api-create-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html +security-api-create-service-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-service-token.html +security-api-delete-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-privilege.html +security-api-delete-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role-mapping.html +security-api-delete-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role.html +security-api-delete-service-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-service-token.html +security-api-delete-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-user.html +security-api-disable-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-disable-user.html +security-api-enable-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-enable-user.html +security-api-get-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-api-key.html +security-api-get-builtin-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-builtin-privileges.html +security-api-get-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-privileges.html +security-api-get-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role-mapping.html +security-api-get-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role.html +security-api-get-service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-accounts.html +security-api-get-service-credentials,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-credentials.html +security-api-get-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-token.html +security-api-get-user-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user-privileges.html +security-api-get-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user.html +security-api-grant-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-grant-api-key.html +security-api-has-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-has-privileges.html +security-api-invalidate-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-api-key.html +security-api-invalidate-token,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-token.html +security-api-kibana-enrollment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-kibana-enrollment.html +security-api-node-enrollment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-node-enrollment.html +security-api-put-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-privileges.html +security-api-put-role-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role-mapping.html +security-api-put-role,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html +security-api-put-user,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-user.html +security-api-query-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-query-api-key.html +security-api-saml-authenticate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-authenticate.html +security-api-saml-complete-logout,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-complete-logout.html +security-api-saml-invalidate,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-invalidate.html +security-api-saml-logout,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-logout.html +security-api-saml-prepare-authentication,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-prepare-authentication.html +security-api-saml-sp-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-sp-metadata.html +security-api-ssl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-ssl.html +set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html +shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html +simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html +slm-api-delete-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-delete-policy.html +slm-api-execute-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-lifecycle.html +slm-api-execute-retention,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-retention.html +slm-api-get-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-policy.html +slm-api-get-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-stats.html +slm-api-get-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-status.html +slm-api-put-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-put-policy.html +slm-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-start.html +slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html +sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html +sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html +sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker +split-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/split-processor.html +sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html +sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html +sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-search-api.html +sql-translate-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-translate-api.html +start-basic,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-basic.html +start-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-dfanalytics.html +start-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trained-model-deployment.html +start-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html +start-trial,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trial.html +stop-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-dfanalytics.html +stop-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html +stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html +supported-flags,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html#supported-flags +tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html +templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query +time-value,https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java +trim-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html +unfreeze-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/unfreeze-index-api.html +update-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html +update-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-license.html +update-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html +upgrade-transforms,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html +uppercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/uppercase-processor.html +urldecode-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/urldecode-processor.html +usage-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/usage-api.html +user-agent-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html +voting-config-exclusions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html +watcher-api-ack-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-ack-watch.html +watcher-api-activate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-activate-watch.html +watcher-api-deactivate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-deactivate-watch.html +watcher-api-delete-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-delete-watch.html +watcher-api-execute-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-execute-watch.html +watcher-api-get-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-get-watch.html +watcher-api-put-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-put-watch.html +watcher-api-query-watches,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-query-watches.html +watcher-api-start,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-start.html +watcher-api-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stats.html +watcher-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stop.html +xpack-rollup,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-rollup.html \ No newline at end of file diff --git a/specification/ingest/_types/Pipeline.ts b/specification/ingest/_types/Pipeline.ts index d0efaaab92..70f9dc786f 100644 --- a/specification/ingest/_types/Pipeline.ts +++ b/specification/ingest/_types/Pipeline.ts @@ -21,9 +21,22 @@ import { VersionNumber } from '@_types/common' import { ProcessorContainer } from './Processors' export class Pipeline { + /** + * Description of the ingest pipeline. + */ description?: string + /** + * Processors to run immediately after a processor failure. + */ on_failure?: ProcessorContainer[] + /** + * Processors used to perform transformations on documents before indexing. + * Processors run sequentially in the order specified. + */ processors?: ProcessorContainer[] + /** + * Version number used by external systems to track ingest pipelines. + */ version?: VersionNumber } @@ -42,7 +55,17 @@ export enum PipelineFailure { } export class PipelineConfig { + /** + * Description of the ingest pipeline. + */ description?: string + /** + * Version number used by external systems to track ingest pipelines. + */ version?: VersionNumber + /** + * Processors used to perform transformations on documents before indexing. + * Processors run sequentially in the order specified. + */ processors: ProcessorContainer[] } diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index a23fcf90c1..ffbf3df8f1 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -30,47 +30,230 @@ import { Script } from '@_types/Scripting' * @non_exhaustive */ export class ProcessorContainer { + /** + * The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. + * @doc_id attachment + */ attachment?: AttachmentProcessor + /** + * Appends one or more values to an existing array if the field already exists and it is an array. + * Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. + * Creates an array containing the provided values if the field doesn’t exist. + * Accepts a single value or an array of values. + * @doc_id append-processor + */ append?: AppendProcessor + /** + * Extracts fields from CSV line out of a single text field within a document. + * Any empty field in CSV will be skipped. + * @doc_id csv-processor + */ csv?: CsvProcessor + /** + * Converts a field in the currently ingested document to a different type, such as converting a string to an integer. + * If the field value is an array, all members will be converted. + * @doc_id convert-processor + */ convert?: ConvertProcessor + /** + * Parses dates from fields, and then uses the date or timestamp as the timestamp for the document. + * @doc_id data-processor + */ date?: DateProcessor + /** + * The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. + * @doc_id date-index-name-processor + */ date_index_name?: DateIndexNameProcessor + /** + * Expands a field with dots into an object field. + * This processor allows fields with dots in the name to be accessible by other processors in the pipeline. + * Otherwise these fields can’t be accessed by any processor. + * @doc_id dot-expand-processor + */ dot_expander?: DotExpanderProcessor + /** + * The `enrich` processor can enrich documents with data from another index. + * @doc_id enrich-processor + */ enrich?: EnrichProcessor + /** + * Raises an exception. + * This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester. + * @doc_id fail-processor + */ fail?: FailProcessor + /** + * Runs an ingest processor on each element of an array or object. + * @doc_id foreach-processor + */ foreach?: ForeachProcessor + /** + * Converts a JSON string into a structured JSON object. + * @doc_id json-processor + */ json?: JsonProcessor + /** + * The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. + * This processor adds this information by default under the `user_agent` field. + * @doc_id user-agent-processor + */ user_agent?: UserAgentProcessor + /** + * This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. + * @doc_id kv-processor + */ kv?: KeyValueProcessor + /** + * The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address. + * @doc_id geoip-processor + */ geoip?: GeoIpProcessor + /** + * Extracts structured fields out of a single text field within a document. + * You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + * A grok pattern is like a regular expression that supports aliased expressions that can be reused. + * @doc_id grok-processor + */ grok?: GrokProcessor + /** + * Converts a string field by applying a regular expression and a replacement. + * If the field is an array of string, all members of the array will be converted. + * If any non-string values are encountered, the processor will throw an exception. + * @doc_id gsub-processor + */ gsub?: GsubProcessor + /** + * Joins each element of an array into a single string using a separator character between each element. + * Throws an error when the field is not an array. + * @doc_id join-processor + */ join?: JoinProcessor + /** + * Converts a string to its lowercase equivalent. + * If the field is an array of strings, all members of the array will be converted. + * @doc_id lowercase-processor + */ lowercase?: LowercaseProcessor + /** + * Removes existing fields. + * If one field doesn’t exist, an exception will be thrown. + * @doc_id remove-processor + */ remove?: RemoveProcessor + /** + * Renames an existing field. + * If the field doesn’t exist or the new name is already used, an exception will be thrown. + * @doc_id rename-processor + */ rename?: RenameProcessor + /** + * Runs an inline or stored script on incoming documents. + * The script runs in the `ingest` context. + * @doc_id script-processor + */ script?: Script + /** + * Adds a field with the specified value. + * If the field already exists, its value will be replaced with the provided one. + * @doc_id set-processor + */ set?: SetProcessor + /** + * Sorts the elements of an array ascending or descending. + * Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. + * Throws an error when the field is not an array. + * @doc_id sort-processor + */ sort?: SortProcessor + /** + * Splits a field into an array using a separator character. + * Only works on string fields. + * @doc_id split-processor + */ split?: SplitProcessor + /** + * Trims whitespace from a field. + * If the field is an array of strings, all members of the array will be trimmed. + * This only works on leading and trailing whitespace. + * @doc_id trim-processor + */ trim?: TrimProcessor + /** + * Converts a string to its uppercase equivalent. + * If the field is an array of strings, all members of the array will be converted. + * @doc_id uppercase-processor + */ uppercase?: UppercaseProcessor + /** + * URL-decodes a string. + * If the field is an array of strings, all members of the array will be decoded. + * @doc_id urldecode-processor + */ urldecode?: UrlDecodeProcessor + /** + * Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`). + * If the field is an array of strings, all members of the array will be converted. + * Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. + * An error will occur if the field is not a supported format or resultant value exceeds 2^63. + * @doc_id bytes-processor + */ bytes?: BytesProcessor + /** + * Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern. + * @doc_id dissect-processor + */ dissect?: DissectProcessor + /** + * Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest. + * @doc_id ingest-node-set-security-user-processor + */ set_security_user?: SetSecurityUserProcessor + /** + * Executes another pipeline. + * @doc_id pipeline-processor + */ pipeline?: PipelineProcessor + /** + * Drops the document without raising any errors. + * This is useful to prevent the document from getting indexed based on some condition. + * @doc_id drop-processor + */ drop?: DropProcessor + /** + * Converts circle definitions of shapes to regular polygons which approximate them. + * @doc_id ingest-circle-processor + */ circle?: CircleProcessor + /** + * Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline. + * @doc_id inference-processor + */ inference?: InferenceProcessor } export class ProcessorBase { + /** + * Description of the processor. + * Useful for describing the purpose of the processor or its configuration. + */ description?: string + /** + * Conditionally execute the processor. + */ if?: string + /** + * Ignore failures for the processor. + */ ignore_failure?: boolean + /** + * Handle failures for the processor. + */ on_failure?: ProcessorContainer[] + /** + * Identifier for the processor. + * Useful for debugging and metrics. + */ tag?: string } @@ -88,49 +271,153 @@ export enum UserAgentProperty { } export class AppendProcessor extends ProcessorBase { + /** + * The field to be appended to. + * Supports template snippets. + */ field: Field + /** + * The value to be appended. Supports template snippets. + */ value: UserDefinedValue[] + /** + * If `false`, the processor does not append values already present in the field. + * @server_default true + */ allow_duplicates?: boolean } export class AttachmentProcessor extends ProcessorBase { + /** + * The field to get the base64 encoded field from. + */ field: Field + /** + * If `true` and field does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The number of chars being used for extraction to prevent huge fields. + * Use `-1` for no limit. + * @server_default 100000 + */ indexed_chars?: long + /** + * Field name from which you can overwrite the number of chars being used for extraction. + * @server_default null + */ indexed_chars_field?: Field + /** + * Array of properties to select to be stored. + * Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + */ properties?: string[] + /** + * The field that will hold the attachment information. + * @server_default attachment + */ target_field?: Field + /** + * Field containing the name of the resource to decode. + * If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + */ resource_name?: string } export class GeoIpProcessor extends ProcessorBase { + /** + * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + * @server_default GeoLite2-City.mmdb + */ database_file?: string + /** + * The field to get the ip address from for the geographical lookup. + */ field: Field + /** + * If `true`, only the first found geoip data will be returned, even if the field contains an array. + * @server_default true + */ first_only?: boolean + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * Controls what properties are added to the `target_field` based on the geoip lookup. + */ properties?: string[] + /** + * The field that will hold the geographical information looked up from the MaxMind database. + * @server_default geoip + */ target_field?: Field } export class UserAgentProcessor extends ProcessorBase { + /** + * The field containing the user agent string. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean options?: UserAgentProperty[] + /** + * The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + */ regex_file?: string + /** + * The field that will be filled with the user agent details. + * @server_default user_agent + */ target_field?: Field } export class BytesProcessor extends ProcessorBase { + /** + * The field to convert. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The field to assign the converted value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class CircleProcessor extends ProcessorBase { + /** + * The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + */ error_distance: double + /** + * The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + */ shape_type: ShapeType + /** + * The field to assign the polygon shape to + * By default, the field is updated in-place. + */ target_field?: Field } @@ -145,23 +432,67 @@ export enum ConvertType { } export class ConvertProcessor extends ProcessorBase { + /** + * The field whose value is to be converted. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The field to assign the converted value to. + * By default, the `field` is updated in-place. + * @server_default field + */ target_field?: Field + /** + * The type to convert the existing value to. + */ type: ConvertType } export class CsvProcessor extends ProcessorBase { + /** + * Value used to fill empty fields. + * Empty fields are skipped if this is not provided. + * An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + */ empty_value?: UserDefinedValue + /** + * The field to extract data from. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + */ ignore_missing?: boolean + /** + * Quote used in CSV, has to be single character string. + * @server_default " + */ quote?: string + /** + * Separator used in CSV, has to be single character string. + * @server_default , + */ separator?: string + /** + * The array of fields to assign extracted values to. + */ target_fields: Fields + /** + * Trim whitespaces in unquoted fields. + */ trim?: boolean } export class DateIndexNameProcessor extends ProcessorBase { + /** + * An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + * Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + */ date_formats: string[] /** * How to round the date when formatting the date into the index name. Valid values are: @@ -169,75 +500,235 @@ export class DateIndexNameProcessor extends ProcessorBase { * Supports template snippets. */ date_rounding: string + /** + * The field to get the date or timestamp from. + */ field: Field + /** + * The format to be used when printing the parsed date into the index name. + * A valid java time pattern is expected here. + * Supports template snippets. + * @server_default yyyy-MM-dd + */ index_name_format?: string + /** + * A prefix of the index name to be prepended before the printed date. + * Supports template snippets. + */ index_name_prefix?: string + /** + * The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + * @server_default ENGLISH + */ locale?: string + /** + * The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + * @server_default UTC + */ timezone?: string } export class DateProcessor extends ProcessorBase { + /** + * The field to get the date from. + */ field: Field + /** + * An array of the expected date formats. + * Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + */ formats: string[] + /** + * The locale to use when parsing the date, relevant when parsing month names or week days. + * Supports template snippets. + * @server_default ENGLISH + */ locale?: string + /** + * The field that will hold the parsed date. + * @server_default `@timestamp` + */ target_field?: Field + /** + * The timezone to use when parsing the date. + * Supports template snippets. + * @server_default UTC + */ timezone?: string } export class DissectProcessor extends ProcessorBase { + /** + * The character(s) that separate the appended fields. + * @server_default "" + */ append_separator?: string + /** + * The field to dissect. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The pattern to apply to the field. + */ pattern: string } export class DotExpanderProcessor extends ProcessorBase { + /** + * The field to expand into an object field. + * If set to `*`, all top-level fields will be expanded. + */ field: Field + /** + * The field that contains the field to expand. + * Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + */ path?: string } export class DropProcessor extends ProcessorBase {} export class EnrichProcessor extends ProcessorBase { + /** + * The field in the input document that matches the policies match_field used to retrieve the enrichment data. + * Supports template snippets. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The maximum number of matched documents to include under the configured target field. + * The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. + * In order to avoid documents getting too large, the maximum allowed value is 128. + * @server_default 1 + */ max_matches?: integer + /** + * If processor will update fields with pre-existing non-null-valued field. + * When set to `false`, such fields will not be touched. + * @server_default true + */ override?: boolean + /** + * The name of the enrich policy to use. + */ policy_name: string + /** + * A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. + * This option is only used for `geo_match` enrich policy types. + * @server_default INTERSECTS + */ shape_relation?: GeoShapeRelation + /** + * Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy. + * Supports template snippets. + */ target_field: Field } export class FailProcessor extends ProcessorBase { + /** + * The error message thrown by the processor. + * Supports template snippets. + */ message: string } export class ForeachProcessor extends ProcessorBase { + /** + * Field containing array or object values. + */ field: Field + /** + * If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + * @server_default false + */ ignore_missing?: boolean + /** + * Ingest processor to run on each element. + */ processor: ProcessorContainer } export class GrokProcessor extends ProcessorBase { + /** + * The field to use for grok expression parsing. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + * Patterns matching existing names will override the pre-existing definition. + */ pattern_definitions?: Dictionary + /** + * An ordered list of grok expression to match and extract named captures with. + * Returns on the first expression in the list that matches. + */ patterns: string[] + /** + * When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + * @server_default false + */ trace_match?: boolean } export class GsubProcessor extends ProcessorBase { + /** + * The field to apply the replacement to. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The pattern to be replaced. + */ pattern: string + /** + * The string to replace the matching patterns with. + */ replacement: string + /** + * The field to assign the converted value to + * By default, the `field` is updated in-place. + * @server_default field + */ target_field?: Field } export class InferenceProcessor extends ProcessorBase { + /** + * The ID or alias for the trained model, or the ID of the deployment. + */ model_id: Id + /** + * Field added to incoming documents to contain results objects. + * @server_default ml.inference. + */ target_field?: Field + /** + * Maps the document field names to the known field names of the model. + * This mapping takes precedence over any default mappings provided in the model configuration. + */ field_map?: Dictionary + /** + * Contains the inference type and its options. + */ inference_config?: InferenceConfig } @@ -245,34 +736,102 @@ export class InferenceProcessor extends ProcessorBase { * @variants container */ export class InferenceConfig { + /** + * Regression configuration for inference. + */ regression?: InferenceConfigRegression + /** + * Classification configuration for inference. + */ classification?: InferenceConfigClassification } export class InferenceConfigRegression { + /** + * The field that is added to incoming documents to contain the inference prediction. + * @server_default _prediction + */ results_field?: Field + /** + * Specifies the maximum number of feature importance values per document. + * @server_default 0 + */ num_top_feature_importance_values?: integer } export class InferenceConfigClassification { + /** + * Specifies the number of top class predictions to return. + * @server_default 0 + */ num_top_classes?: integer + /** + * Specifies the maximum number of feature importance values per document. + * @server_default 0 + */ num_top_feature_importance_values?: integer + /** + * The field that is added to incoming documents to contain the inference prediction. + * @server_default _prediction + */ results_field?: Field + /** + * Specifies the field to which the top classes are written. + * @server_default top_classes + */ top_classes_results_field?: Field + /** + * Specifies the type of the predicted field to write. + * Valid values are: `string`, `number`, `boolean`. + */ prediction_field_type?: string } export class JoinProcessor extends ProcessorBase { + /** + * Field containing array values to join. + */ field: Field + /** + * The separator character. + */ separator: string + /** + * The field to assign the joined value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class JsonProcessor extends ProcessorBase { + /** + * Flag that forces the parsed JSON to be added at the top level of the document. + * `target_field` must not be set when this option is chosen. + * @server_default false + */ add_to_root?: boolean + /** + * When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden. + * When set to `merge`, conflicting fields will be merged. + * Only applicable `if add_to_root` is set to true. + */ add_to_root_conflict_strategy?: JsonProcessorConflictStrategy + /** + * When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. + * Instead, the last encountered value for any duplicate key wins. + * @server_default false + */ allow_duplicate_keys?: boolean + /** + * The field to be parsed. + */ field: Field + /** + * The field that the converted structured object will be written into. + * Any existing content in this field will be overwritten. + * @server_default field + */ target_field?: Field } @@ -284,59 +843,186 @@ export enum JsonProcessorConflictStrategy { } export class KeyValueProcessor extends ProcessorBase { + /** + * List of keys to exclude from document. + */ exclude_keys?: string[] + /** + * The field to be parsed. + * Supports template snippets. + */ field: Field + /** + * Regex pattern to use for splitting key-value pairs. + */ field_split: string + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * List of keys to filter and insert into document. + * Defaults to including all keys. + */ include_keys?: string[] + /** + * Prefix to be added to extracted keys. + * @server_default null + */ prefix?: string + /** + * If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + * @server_default false + */ strip_brackets?: boolean + /** + * The field to insert the extracted keys into. + * Defaults to the root of the document. + * Supports template snippets. + */ target_field?: Field + /** + * String of characters to trim from extracted keys. + */ trim_key?: string + /** + * String of characters to trim from extracted values. + */ trim_value?: string + /** + * Regex pattern to use for splitting the key from the value within a key-value pair. + */ value_split: string } export class LowercaseProcessor extends ProcessorBase { + /** + * The field to make lowercase. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The field to assign the converted value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class PipelineProcessor extends ProcessorBase { + /** + * The name of the pipeline to execute. + * Supports template snippets. + */ name: Name + /** + * Whether to ignore missing pipelines instead of failing. + * @server_default false + */ ignore_missing_pipeline?: boolean } export class RemoveProcessor extends ProcessorBase { + /** + * Fields to be removed. Supports template snippets. + */ field: Fields + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean } export class RenameProcessor extends ProcessorBase { + /** + * The field to be renamed. + * Supports template snippets. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The new name of the field. + * Supports template snippets. + */ target_field: Field } export class ScriptProcessor extends ProcessorBase { + /** + * ID of a stored script. + * If no `source` is specified, this parameter is required. + */ id?: Id + /** + * Script language. + * @server_default painless + */ lang?: string + /** + * Object containing parameters for the script. + */ params?: Dictionary + /** + * Inline script. + * If no `id` is specified, this parameter is required. + */ source?: string } export class SetProcessor extends ProcessorBase { + /** + * The origin field which will be copied to `field`, cannot set `value` simultaneously. + * Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + */ copy_from?: Field + /** + * The field to insert, upsert, or update. + * Supports template snippets. + */ field: Field + /** + * If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_empty_value?: boolean + /** + * The media type for encoding `value`. + * Applies only when value is a template snippet. + * Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + */ media_type?: string + /** + * If `true` processor will update fields with pre-existing non-null-valued field. + * When set to `false`, such fields will not be touched. + * @server_default true + */ override?: boolean + /** + * The value to be set for the field. + * Supports template snippets. + * May specify only one of `value` or `copy_from`. + */ value?: UserDefinedValue } export class SetSecurityUserProcessor extends ProcessorBase { + /** + * The field to store the user information into. + */ field: Field + /** + * Controls what user related properties are added to the field. + */ properties?: string[] } @@ -346,33 +1032,100 @@ export enum ShapeType { } export class SortProcessor extends ProcessorBase { + /** + * The field to be sorted. + */ field: Field + /** + * The sort order to use. + * Accepts `"asc"` or `"desc"`. + * @server_default asc + */ order?: SortOrder + /** + * The field to assign the sorted value to. + * By default, the field is updated in-place. + */ target_field?: Field } export class SplitProcessor extends ProcessorBase { + /** + * The field to split. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * Preserves empty trailing fields, if any. + * @server_default false + */ preserve_trailing?: boolean + /** + * A regex which matches the separator, for example, `,` or `\s+`. + */ separator: string + /** + * The field to assign the split value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class TrimProcessor extends ProcessorBase { + /** + * The string-valued field to trim whitespace from. + */ field: Field + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The field to assign the trimmed value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class UppercaseProcessor extends ProcessorBase { + /** + * The field to make uppercase. + */ field: Field + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ ignore_missing?: boolean + /** + * The field to assign the converted value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } export class UrlDecodeProcessor extends ProcessorBase { + /** + * The field to decode. + */ field: Field - ignore_missing?: boolean + /** + * If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + * @server_default false + */ + ignre_missing?: boolean + /** + * The field to assign the converted value to. + * By default, the field is updated in-place. + * @server_default field + */ target_field?: Field } diff --git a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts index 179845b5a7..c5b59f07ec 100644 --- a/specification/ingest/delete_pipeline/DeletePipelineRequest.ts +++ b/specification/ingest/delete_pipeline/DeletePipelineRequest.ts @@ -22,16 +22,31 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Deletes one or more existing ingest pipeline. * @rest_spec_name ingest.delete_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Pipeline ID or wildcard expression of pipeline IDs used to limit the request. + * To delete all ingest pipelines in a cluster, use a value of `*`. + */ id: Id } query_parameters: { + /** + * Period to wait for a connection to the master node. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ master_timeout?: Duration + /** + * Period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ timeout?: Duration } } diff --git a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts index 45712fdf16..bda5f2b039 100644 --- a/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts +++ b/specification/ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Gets download statistics for GeoIP2 databases used with the geoip processor. + * @doc_id geoip-processor * @rest_spec_name ingest.geo_ip_stats * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ingest/get_pipeline/GetPipelineRequest.ts b/specification/ingest/get_pipeline/GetPipelineRequest.ts index 8a75e79b03..2561c9d72f 100644 --- a/specification/ingest/get_pipeline/GetPipelineRequest.ts +++ b/specification/ingest/get_pipeline/GetPipelineRequest.ts @@ -22,18 +22,29 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** + * Returns information about one or more ingest pipelines. + * This API returns a local reference of the pipeline. * @rest_spec_name ingest.get_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Comma-separated list of pipeline IDs to retrieve. + * Wildcard (`*`) expressions are supported. + * To get all ingest pipelines, omit this parameter or use `*`. + */ id?: Id } query_parameters: { - /** @server_default 30s */ + /** + * Period to wait for a connection to the master node. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s */ master_timeout?: Duration - /** @server_default false */ + /** + * @server_default false */ summary?: boolean } } diff --git a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts index 62b81d6c23..7a44513679 100644 --- a/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts +++ b/specification/ingest/processor_grok/GrokProcessorPatternsRequest.ts @@ -20,6 +20,10 @@ import { RequestBase } from '@_types/Base' /** + * Extracts structured fields out of a single text field within a document. + * You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + * A grok pattern is like a regular expression that supports aliased expressions that can be reused. + * @doc_id grok-processor * @rest_spec_name ingest.processor_grok * @availability stack since=6.1.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ingest/put_pipeline/PutPipelineRequest.ts b/specification/ingest/put_pipeline/PutPipelineRequest.ts index 36dd9a8e5d..4f966a9e82 100644 --- a/specification/ingest/put_pipeline/PutPipelineRequest.ts +++ b/specification/ingest/put_pipeline/PutPipelineRequest.ts @@ -23,6 +23,9 @@ import { Id, VersionNumber, Metadata } from '@_types/common' import { Duration } from '@_types/Time' /** + * Creates or updates an ingest pipeline. + * Changes made using this API take effect immediately. + * @doc_id ingest * @rest_spec_name ingest.put_pipeline * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ingest/simulate/SimulatePipelineRequest.ts b/specification/ingest/simulate/SimulatePipelineRequest.ts index e1031a50c7..87f215e760 100644 --- a/specification/ingest/simulate/SimulatePipelineRequest.ts +++ b/specification/ingest/simulate/SimulatePipelineRequest.ts @@ -23,19 +23,35 @@ import { Id } from '@_types/common' import { Document } from './types' /** + * Executes an ingest pipeline against a set of provided documents. * @rest_spec_name ingest.simulate * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public */ export interface Request extends RequestBase { path_parts: { + /** + * Pipeline to test. + * If you don’t specify a `pipeline` in the request body, this parameter is required. + */ id?: Id } query_parameters: { + /** + * If `true`, the response includes output data for each processor in the executed pipeline. + */ verbose?: boolean } body: { + /** + * Sample documents to test in the pipeline. + */ docs?: Document[] + /** + * Pipeline to test. + * If you don’t specify the `pipeline` request path parameter, this parameter is required. + * If you specify both this and the request path parameter, the API only uses the request path parameter. + */ pipeline?: Pipeline } } diff --git a/specification/ingest/simulate/types.ts b/specification/ingest/simulate/types.ts index 24db708c79..450d1267fe 100644 --- a/specification/ingest/simulate/types.ts +++ b/specification/ingest/simulate/types.ts @@ -39,8 +39,18 @@ export class PipelineSimulation { } export class Document { + /** + * Unique identifier for the document. + * This ID must be unique within the `_index`. + */ _id?: Id + /** + * Name of the index containing the document. + */ _index?: IndexName + /** + * JSON body for the document. + */ _source: UserDefinedValue } @@ -50,11 +60,26 @@ export class Document { export class DocumentSimulation implements AdditionalProperties { + /** + * Unique identifier for the document. This ID must be unique within the `_index`. + */ _id: Id + /** + * Name of the index containing the document. + */ _index: IndexName _ingest: Ingest + /** + * Value used to send the document to a specific primary shard. + */ _routing?: string + /** + * JSON body for the document. + */ _source: Dictionary + /** + * + */ _version?: Stringified _version_type?: VersionType }