From 9c065504ce0be03d71cd03898248a6e48319742b Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Tue, 2 Jul 2024 11:50:45 +0400 Subject: [PATCH] Order ingest pipelines by name --- output/openapi/elasticsearch-openapi.json | 878 +++---- .../elasticsearch-serverless-openapi.json | 878 +++---- output/schema/schema-serverless.json | 2124 ++++++++--------- output/schema/schema.json | 268 +-- output/typescript/types.ts | 24 +- specification/ingest/_types/Processors.ts | 124 +- 6 files changed, 2148 insertions(+), 2148 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index a93efdc06d..25d5138db9 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -83316,27 +83316,39 @@ "ingest._types:ProcessorContainer": { "type": "object", "properties": { + "append": { + "$ref": "#/components/schemas/ingest._types:AppendProcessor" + }, "attachment": { "$ref": "#/components/schemas/ingest._types:AttachmentProcessor" }, - "append": { - "$ref": "#/components/schemas/ingest._types:AppendProcessor" + "bytes": { + "$ref": "#/components/schemas/ingest._types:BytesProcessor" }, - "csv": { - "$ref": "#/components/schemas/ingest._types:CsvProcessor" + "circle": { + "$ref": "#/components/schemas/ingest._types:CircleProcessor" }, "convert": { "$ref": "#/components/schemas/ingest._types:ConvertProcessor" }, + "csv": { + "$ref": "#/components/schemas/ingest._types:CsvProcessor" + }, "date": { "$ref": "#/components/schemas/ingest._types:DateProcessor" }, "date_index_name": { "$ref": "#/components/schemas/ingest._types:DateIndexNameProcessor" }, + "dissect": { + "$ref": "#/components/schemas/ingest._types:DissectProcessor" + }, "dot_expander": { "$ref": "#/components/schemas/ingest._types:DotExpanderProcessor" }, + "drop": { + "$ref": "#/components/schemas/ingest._types:DropProcessor" + }, "enrich": { "$ref": "#/components/schemas/ingest._types:EnrichProcessor" }, @@ -83346,15 +83358,6 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, - "json": { - "$ref": "#/components/schemas/ingest._types:JsonProcessor" - }, - "user_agent": { - "$ref": "#/components/schemas/ingest._types:UserAgentProcessor" - }, - "kv": { - "$ref": "#/components/schemas/ingest._types:KeyValueProcessor" - }, "geoip": { "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" }, @@ -83364,12 +83367,24 @@ "gsub": { "$ref": "#/components/schemas/ingest._types:GsubProcessor" }, + "inference": { + "$ref": "#/components/schemas/ingest._types:InferenceProcessor" + }, "join": { "$ref": "#/components/schemas/ingest._types:JoinProcessor" }, + "json": { + "$ref": "#/components/schemas/ingest._types:JsonProcessor" + }, + "kv": { + "$ref": "#/components/schemas/ingest._types:KeyValueProcessor" + }, "lowercase": { "$ref": "#/components/schemas/ingest._types:LowercaseProcessor" }, + "pipeline": { + "$ref": "#/components/schemas/ingest._types:PipelineProcessor" + }, "remove": { "$ref": "#/components/schemas/ingest._types:RemoveProcessor" }, @@ -83385,6 +83400,9 @@ "set": { "$ref": "#/components/schemas/ingest._types:SetProcessor" }, + "set_security_user": { + "$ref": "#/components/schemas/ingest._types:SetSecurityUserProcessor" + }, "sort": { "$ref": "#/components/schemas/ingest._types:SortProcessor" }, @@ -83400,32 +83418,14 @@ "urldecode": { "$ref": "#/components/schemas/ingest._types:UrlDecodeProcessor" }, - "bytes": { - "$ref": "#/components/schemas/ingest._types:BytesProcessor" - }, - "dissect": { - "$ref": "#/components/schemas/ingest._types:DissectProcessor" - }, - "set_security_user": { - "$ref": "#/components/schemas/ingest._types:SetSecurityUserProcessor" - }, - "pipeline": { - "$ref": "#/components/schemas/ingest._types:PipelineProcessor" - }, - "drop": { - "$ref": "#/components/schemas/ingest._types:DropProcessor" - }, - "circle": { - "$ref": "#/components/schemas/ingest._types:CircleProcessor" - }, - "inference": { - "$ref": "#/components/schemas/ingest._types:InferenceProcessor" + "user_agent": { + "$ref": "#/components/schemas/ingest._types:UserAgentProcessor" } }, "minProperties": 1, "maxProperties": 1 }, - "ingest._types:AttachmentProcessor": { + "ingest._types:AppendProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83436,38 +83436,21 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "indexed_chars": { - "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", - "type": "number" - }, - "indexed_chars_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "properties": { - "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", + "value": { + "description": "The value to be appended. Supports template snippets.", "type": "array", "items": { - "type": "string" + "type": "object" } }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "remove_binary": { - "description": "If true, the binary field will be removed from the document", + "allow_duplicates": { + "description": "If `false`, the processor does not append values already present in the field.", "type": "boolean" - }, - "resource_name": { - "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.", - "type": "string" } }, "required": [ - "field" + "field", + "value" ] } ] @@ -83500,7 +83483,7 @@ } } }, - "ingest._types:AppendProcessor": { + "ingest._types:AttachmentProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83511,26 +83494,68 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "value": { - "description": "The value to be appended. Supports template snippets.", + "ignore_missing": { + "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "indexed_chars": { + "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", + "type": "number" + }, + "indexed_chars_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "properties": { + "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", "type": "array", "items": { - "type": "object" + "type": "string" } }, - "allow_duplicates": { - "description": "If `false`, the processor does not append values already present in the field.", + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "remove_binary": { + "description": "If true, the binary field will be removed from the document", + "type": "boolean" + }, + "resource_name": { + "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.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:BytesProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "value" + "field" ] } ] }, - "ingest._types:CsvProcessor": { + "ingest._types:CircleProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83538,9 +83563,9 @@ { "type": "object", "properties": { - "empty_value": { - "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", - "type": "object" + "error_distance": { + "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`).", + "type": "number" }, "field": { "$ref": "#/components/schemas/_types:Field" @@ -83549,29 +83574,28 @@ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "type": "boolean" }, - "quote": { - "description": "Quote used in CSV, has to be single character string.", - "type": "string" - }, - "separator": { - "description": "Separator used in CSV, has to be single character string.", - "type": "string" - }, - "target_fields": { - "$ref": "#/components/schemas/_types:Fields" + "shape_type": { + "$ref": "#/components/schemas/ingest._types:ShapeType" }, - "trim": { - "description": "Trim whitespaces in unquoted fields.", - "type": "boolean" + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ + "error_distance", "field", - "target_fields" + "shape_type" ] } ] }, + "ingest._types:ShapeType": { + "type": "string", + "enum": [ + "geo_shape", + "shape" + ] + }, "ingest._types:ConvertProcessor": { "allOf": [ { @@ -83613,6 +83637,48 @@ "auto" ] }, + "ingest._types:CsvProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "empty_value": { + "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", + "type": "object" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "quote": { + "description": "Quote used in CSV, has to be single character string.", + "type": "string" + }, + "separator": { + "description": "Separator used in CSV, has to be single character string.", + "type": "string" + }, + "target_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "trim": { + "description": "Trim whitespaces in unquoted fields.", + "type": "boolean" + } + }, + "required": [ + "field", + "target_fields" + ] + } + ] + }, "ingest._types:DateProcessor": { "allOf": [ { @@ -83697,7 +83763,7 @@ } ] }, - "ingest._types:DotExpanderProcessor": { + "ingest._types:DissectProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83705,21 +83771,30 @@ { "type": "object", "properties": { + "append_separator": { + "description": "The character(s) that separate the appended fields.", + "type": "string" + }, "field": { "$ref": "#/components/schemas/_types:Field" }, - "path": { - "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.", + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "pattern": { + "description": "The pattern to apply to the field.", "type": "string" } }, "required": [ - "field" + "field", + "pattern" ] } ] }, - "ingest._types:EnrichProcessor": { + "ingest._types:DotExpanderProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83730,9 +83805,41 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" + "path": { + "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.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:DropProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object" + } + ] + }, + "ingest._types:EnrichProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" }, "max_matches": { "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.", @@ -83815,7 +83922,7 @@ } ] }, - "ingest._types:JsonProcessor": { + "ingest._types:GeoIpProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83823,19 +83930,27 @@ { "type": "object", "properties": { - "add_to_root": { - "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.", - "type": "boolean" + "database_file": { + "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.", + "type": "string" }, - "add_to_root_conflict_strategy": { - "$ref": "#/components/schemas/ingest._types:JsonProcessorConflictStrategy" + "field": { + "$ref": "#/components/schemas/_types:Field" }, - "allow_duplicate_keys": { - "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.", + "first_only": { + "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", "type": "boolean" }, - "field": { - "$ref": "#/components/schemas/_types:Field" + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "properties": { + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "type": "array", + "items": { + "type": "string" + } }, "target_field": { "$ref": "#/components/schemas/_types:Field" @@ -83847,14 +83962,7 @@ } ] }, - "ingest._types:JsonProcessorConflictStrategy": { - "type": "string", - "enum": [ - "replace", - "merge" - ] - }, - "ingest._types:UserAgentProcessor": { + "ingest._types:GrokProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83866,45 +83974,36 @@ "$ref": "#/components/schemas/_types:Field" }, "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "options": { + "pattern_definitions": { + "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.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "patterns": { + "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", "type": "array", "items": { - "$ref": "#/components/schemas/ingest._types:UserAgentProperty" + "type": "string" } }, - "regex_file": { - "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.", - "type": "string" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" + "trace_match": { + "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.", + "type": "boolean" } }, "required": [ - "field" + "field", + "patterns" ] } ] }, - "ingest._types:UserAgentProperty": { - "type": "string", - "enum": [ - "NAME", - "MAJOR", - "MINOR", - "PATCH", - "OS", - "OS_NAME", - "OS_MAJOR", - "OS_MINOR", - "DEVICE", - "BUILD" - ] - }, - "ingest._types:KeyValueProcessor": { + "ingest._types:GsubProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83912,64 +84011,34 @@ { "type": "object", "properties": { - "exclude_keys": { - "description": "List of keys to exclude from document.", - "type": "array", - "items": { - "type": "string" - } - }, "field": { "$ref": "#/components/schemas/_types:Field" }, - "field_split": { - "description": "Regex pattern to use for splitting key-value pairs.", - "type": "string" - }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "include_keys": { - "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", - "type": "array", - "items": { - "type": "string" - } - }, - "prefix": { - "description": "Prefix to be added to extracted keys.", + "pattern": { + "description": "The pattern to be replaced.", "type": "string" }, - "strip_brackets": { - "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", - "type": "boolean" + "replacement": { + "description": "The string to replace the matching patterns with.", + "type": "string" }, "target_field": { "$ref": "#/components/schemas/_types:Field" - }, - "trim_key": { - "description": "String of characters to trim from extracted keys.", - "type": "string" - }, - "trim_value": { - "description": "String of characters to trim from extracted values.", - "type": "string" - }, - "value_split": { - "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", - "type": "string" } }, "required": [ "field", - "field_split", - "value_split" + "pattern", + "replacement" ] } ] }, - "ingest._types:GeoIpProcessor": { + "ingest._types:InferenceProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -83977,39 +84046,78 @@ { "type": "object", "properties": { - "database_file": { - "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.", - "type": "string" + "model_id": { + "$ref": "#/components/schemas/_types:Id" }, - "field": { + "target_field": { "$ref": "#/components/schemas/_types:Field" }, - "first_only": { - "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", - "type": "boolean" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "properties": { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", - "type": "array", - "items": { - "type": "string" + "field_map": { + "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.", + "type": "object", + "additionalProperties": { + "type": "object" } }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" + "inference_config": { + "$ref": "#/components/schemas/ingest._types:InferenceConfig" } }, "required": [ - "field" + "model_id" ] } ] }, - "ingest._types:GrokProcessor": { + "ingest._types:InferenceConfig": { + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigRegression" + }, + "classification": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigClassification" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ingest._types:InferenceConfigRegression": { + "type": "object", + "properties": { + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + } + } + }, + "ingest._types:InferenceConfigClassification": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return.", + "type": "number" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + }, + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "top_classes_results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "prediction_field_type": { + "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", + "type": "string" + } + } + }, + "ingest._types:JoinProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -84020,37 +84128,61 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "type": "boolean" + "separator": { + "description": "The separator character.", + "type": "string" }, - "pattern_definitions": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "separator" + ] + } + ] + }, + "ingest._types:JsonProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "add_to_root": { + "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.", + "type": "boolean" }, - "patterns": { - "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", - "type": "array", - "items": { - "type": "string" - } + "add_to_root_conflict_strategy": { + "$ref": "#/components/schemas/ingest._types:JsonProcessorConflictStrategy" }, - "trace_match": { - "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.", + "allow_duplicate_keys": { + "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.", "type": "boolean" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "patterns" + "field" ] } ] }, - "ingest._types:GsubProcessor": { + "ingest._types:JsonProcessorConflictStrategy": { + "type": "string", + "enum": [ + "replace", + "merge" + ] + }, + "ingest._types:KeyValueProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -84058,34 +84190,64 @@ { "type": "object", "properties": { + "exclude_keys": { + "description": "List of keys to exclude from document.", + "type": "array", + "items": { + "type": "string" + } + }, "field": { "$ref": "#/components/schemas/_types:Field" }, + "field_split": { + "description": "Regex pattern to use for splitting key-value pairs.", + "type": "string" + }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "pattern": { - "description": "The pattern to be replaced.", - "type": "string" + "include_keys": { + "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", + "type": "array", + "items": { + "type": "string" + } }, - "replacement": { - "description": "The string to replace the matching patterns with.", + "prefix": { + "description": "Prefix to be added to extracted keys.", "type": "string" }, + "strip_brackets": { + "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", + "type": "boolean" + }, "target_field": { "$ref": "#/components/schemas/_types:Field" + }, + "trim_key": { + "description": "String of characters to trim from extracted keys.", + "type": "string" + }, + "trim_value": { + "description": "String of characters to trim from extracted values.", + "type": "string" + }, + "value_split": { + "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", + "type": "string" } }, "required": [ "field", - "pattern", - "replacement" + "field_split", + "value_split" ] } ] }, - "ingest._types:JoinProcessor": { + "ingest._types:LowercaseProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -84096,22 +84258,21 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "separator": { - "description": "The separator character.", - "type": "string" + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "type": "boolean" }, "target_field": { "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "separator" + "field" ] } ] }, - "ingest._types:LowercaseProcessor": { + "ingest._types:PipelineProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -84119,19 +84280,16 @@ { "type": "object", "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" + "name": { + "$ref": "#/components/schemas/_types:Name" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "ignore_missing_pipeline": { + "description": "Whether to ignore missing pipelines instead of failing.", "type": "boolean" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field" + "name" ] } ] @@ -84298,6 +84456,31 @@ } ] }, + "ingest._types:SetSecurityUserProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "properties": { + "description": "Controls what user related properties are added to the field.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:SortProcessor": { "allOf": [ { @@ -84431,32 +84614,7 @@ } ] }, - "ingest._types:BytesProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - } - }, - "required": [ - "field" - ] - } - ] - }, - "ingest._types:DissectProcessor": { + "ingest._types:UserAgentProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -84464,206 +84622,48 @@ { "type": "object", "properties": { - "append_separator": { - "description": "The character(s) that separate the appended fields.", - "type": "string" - }, "field": { "$ref": "#/components/schemas/_types:Field" }, "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "type": "boolean" }, - "pattern": { - "description": "The pattern to apply to the field.", - "type": "string" - } - }, - "required": [ - "field", - "pattern" - ] - } - ] - }, - "ingest._types:SetSecurityUserProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "properties": { - "description": "Controls what user related properties are added to the field.", + "options": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ingest._types:UserAgentProperty" } - } - }, - "required": [ - "field" - ] - } - ] - }, - "ingest._types:PipelineProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "ignore_missing_pipeline": { - "description": "Whether to ignore missing pipelines instead of failing.", - "type": "boolean" - } - }, - "required": [ - "name" - ] - } - ] - }, - "ingest._types:DropProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object" - } - ] - }, - "ingest._types:CircleProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "error_distance": { - "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`).", - "type": "number" - }, - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" }, - "shape_type": { - "$ref": "#/components/schemas/ingest._types:ShapeType" + "regex_file": { + "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.", + "type": "string" }, "target_field": { "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "error_distance", - "field", - "shape_type" + "field" ] } ] }, - "ingest._types:ShapeType": { + "ingest._types:UserAgentProperty": { "type": "string", "enum": [ - "geo_shape", - "shape" - ] - }, - "ingest._types:InferenceProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "model_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "field_map": { - "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.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "inference_config": { - "$ref": "#/components/schemas/ingest._types:InferenceConfig" - } - }, - "required": [ - "model_id" - ] - } + "NAME", + "MAJOR", + "MINOR", + "PATCH", + "OS", + "OS_NAME", + "OS_MAJOR", + "OS_MINOR", + "DEVICE", + "BUILD" ] }, - "ingest._types:InferenceConfig": { - "type": "object", - "properties": { - "regression": { - "$ref": "#/components/schemas/ingest._types:InferenceConfigRegression" - }, - "classification": { - "$ref": "#/components/schemas/ingest._types:InferenceConfigClassification" - } - }, - "minProperties": 1, - "maxProperties": 1 - }, - "ingest._types:InferenceConfigRegression": { - "type": "object", - "properties": { - "results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "num_top_feature_importance_values": { - "description": "Specifies the maximum number of feature importance values per document.", - "type": "number" - } - } - }, - "ingest._types:InferenceConfigClassification": { - "type": "object", - "properties": { - "num_top_classes": { - "description": "Specifies the number of top class predictions to return.", - "type": "number" - }, - "num_top_feature_importance_values": { - "description": "Specifies the maximum number of feature importance values per document.", - "type": "number" - }, - "results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "top_classes_results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "prediction_field_type": { - "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", - "type": "string" - } - } - }, "ingest.simulate:Document": { "type": "object", "properties": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 5af9e80fe9..aa5e2584f3 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -53474,27 +53474,39 @@ "ingest._types:ProcessorContainer": { "type": "object", "properties": { + "append": { + "$ref": "#/components/schemas/ingest._types:AppendProcessor" + }, "attachment": { "$ref": "#/components/schemas/ingest._types:AttachmentProcessor" }, - "append": { - "$ref": "#/components/schemas/ingest._types:AppendProcessor" + "bytes": { + "$ref": "#/components/schemas/ingest._types:BytesProcessor" }, - "csv": { - "$ref": "#/components/schemas/ingest._types:CsvProcessor" + "circle": { + "$ref": "#/components/schemas/ingest._types:CircleProcessor" }, "convert": { "$ref": "#/components/schemas/ingest._types:ConvertProcessor" }, + "csv": { + "$ref": "#/components/schemas/ingest._types:CsvProcessor" + }, "date": { "$ref": "#/components/schemas/ingest._types:DateProcessor" }, "date_index_name": { "$ref": "#/components/schemas/ingest._types:DateIndexNameProcessor" }, + "dissect": { + "$ref": "#/components/schemas/ingest._types:DissectProcessor" + }, "dot_expander": { "$ref": "#/components/schemas/ingest._types:DotExpanderProcessor" }, + "drop": { + "$ref": "#/components/schemas/ingest._types:DropProcessor" + }, "enrich": { "$ref": "#/components/schemas/ingest._types:EnrichProcessor" }, @@ -53504,15 +53516,6 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, - "json": { - "$ref": "#/components/schemas/ingest._types:JsonProcessor" - }, - "user_agent": { - "$ref": "#/components/schemas/ingest._types:UserAgentProcessor" - }, - "kv": { - "$ref": "#/components/schemas/ingest._types:KeyValueProcessor" - }, "geoip": { "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" }, @@ -53522,12 +53525,24 @@ "gsub": { "$ref": "#/components/schemas/ingest._types:GsubProcessor" }, + "inference": { + "$ref": "#/components/schemas/ingest._types:InferenceProcessor" + }, "join": { "$ref": "#/components/schemas/ingest._types:JoinProcessor" }, + "json": { + "$ref": "#/components/schemas/ingest._types:JsonProcessor" + }, + "kv": { + "$ref": "#/components/schemas/ingest._types:KeyValueProcessor" + }, "lowercase": { "$ref": "#/components/schemas/ingest._types:LowercaseProcessor" }, + "pipeline": { + "$ref": "#/components/schemas/ingest._types:PipelineProcessor" + }, "remove": { "$ref": "#/components/schemas/ingest._types:RemoveProcessor" }, @@ -53543,6 +53558,9 @@ "set": { "$ref": "#/components/schemas/ingest._types:SetProcessor" }, + "set_security_user": { + "$ref": "#/components/schemas/ingest._types:SetSecurityUserProcessor" + }, "sort": { "$ref": "#/components/schemas/ingest._types:SortProcessor" }, @@ -53558,32 +53576,14 @@ "urldecode": { "$ref": "#/components/schemas/ingest._types:UrlDecodeProcessor" }, - "bytes": { - "$ref": "#/components/schemas/ingest._types:BytesProcessor" - }, - "dissect": { - "$ref": "#/components/schemas/ingest._types:DissectProcessor" - }, - "set_security_user": { - "$ref": "#/components/schemas/ingest._types:SetSecurityUserProcessor" - }, - "pipeline": { - "$ref": "#/components/schemas/ingest._types:PipelineProcessor" - }, - "drop": { - "$ref": "#/components/schemas/ingest._types:DropProcessor" - }, - "circle": { - "$ref": "#/components/schemas/ingest._types:CircleProcessor" - }, - "inference": { - "$ref": "#/components/schemas/ingest._types:InferenceProcessor" + "user_agent": { + "$ref": "#/components/schemas/ingest._types:UserAgentProcessor" } }, "minProperties": 1, "maxProperties": 1 }, - "ingest._types:AttachmentProcessor": { + "ingest._types:AppendProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53594,38 +53594,21 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "indexed_chars": { - "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", - "type": "number" - }, - "indexed_chars_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "properties": { - "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", + "value": { + "description": "The value to be appended. Supports template snippets.", "type": "array", "items": { - "type": "string" + "type": "object" } }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "remove_binary": { - "description": "If true, the binary field will be removed from the document", + "allow_duplicates": { + "description": "If `false`, the processor does not append values already present in the field.", "type": "boolean" - }, - "resource_name": { - "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.", - "type": "string" } }, "required": [ - "field" + "field", + "value" ] } ] @@ -53658,7 +53641,7 @@ } } }, - "ingest._types:AppendProcessor": { + "ingest._types:AttachmentProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53669,26 +53652,68 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "value": { - "description": "The value to be appended. Supports template snippets.", + "ignore_missing": { + "description": "If `true` and field does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "indexed_chars": { + "description": "The number of chars being used for extraction to prevent huge fields.\nUse `-1` for no limit.", + "type": "number" + }, + "indexed_chars_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "properties": { + "description": "Array of properties to select to be stored.\nCan be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.", "type": "array", "items": { - "type": "object" + "type": "string" } }, - "allow_duplicates": { - "description": "If `false`, the processor does not append values already present in the field.", + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "remove_binary": { + "description": "If true, the binary field will be removed from the document", + "type": "boolean" + }, + "resource_name": { + "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.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:BytesProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "value" + "field" ] } ] }, - "ingest._types:CsvProcessor": { + "ingest._types:CircleProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53696,9 +53721,9 @@ { "type": "object", "properties": { - "empty_value": { - "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", - "type": "object" + "error_distance": { + "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`).", + "type": "number" }, "field": { "$ref": "#/components/schemas/_types:Field" @@ -53707,29 +53732,28 @@ "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "type": "boolean" }, - "quote": { - "description": "Quote used in CSV, has to be single character string.", - "type": "string" - }, - "separator": { - "description": "Separator used in CSV, has to be single character string.", - "type": "string" - }, - "target_fields": { - "$ref": "#/components/schemas/_types:Fields" + "shape_type": { + "$ref": "#/components/schemas/ingest._types:ShapeType" }, - "trim": { - "description": "Trim whitespaces in unquoted fields.", - "type": "boolean" + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ + "error_distance", "field", - "target_fields" + "shape_type" ] } ] }, + "ingest._types:ShapeType": { + "type": "string", + "enum": [ + "geo_shape", + "shape" + ] + }, "ingest._types:ConvertProcessor": { "allOf": [ { @@ -53771,6 +53795,48 @@ "auto" ] }, + "ingest._types:CsvProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "empty_value": { + "description": "Value used to fill empty fields.\nEmpty fields are skipped if this is not provided.\nAn empty field is one with no value (2 consecutive separators) or empty quotes (`\"\"`).", + "type": "object" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "quote": { + "description": "Quote used in CSV, has to be single character string.", + "type": "string" + }, + "separator": { + "description": "Separator used in CSV, has to be single character string.", + "type": "string" + }, + "target_fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "trim": { + "description": "Trim whitespaces in unquoted fields.", + "type": "boolean" + } + }, + "required": [ + "field", + "target_fields" + ] + } + ] + }, "ingest._types:DateProcessor": { "allOf": [ { @@ -53855,7 +53921,7 @@ } ] }, - "ingest._types:DotExpanderProcessor": { + "ingest._types:DissectProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53863,21 +53929,30 @@ { "type": "object", "properties": { + "append_separator": { + "description": "The character(s) that separate the appended fields.", + "type": "string" + }, "field": { "$ref": "#/components/schemas/_types:Field" }, - "path": { - "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.", + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "pattern": { + "description": "The pattern to apply to the field.", "type": "string" } }, "required": [ - "field" + "field", + "pattern" ] } ] }, - "ingest._types:EnrichProcessor": { + "ingest._types:DotExpanderProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53888,9 +53963,41 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" + "path": { + "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.", + "type": "string" + } + }, + "required": [ + "field" + ] + } + ] + }, + "ingest._types:DropProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object" + } + ] + }, + "ingest._types:EnrichProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" }, "max_matches": { "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.", @@ -53973,7 +54080,7 @@ } ] }, - "ingest._types:JsonProcessor": { + "ingest._types:GeoIpProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -53981,19 +54088,27 @@ { "type": "object", "properties": { - "add_to_root": { - "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.", - "type": "boolean" + "database_file": { + "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.", + "type": "string" }, - "add_to_root_conflict_strategy": { - "$ref": "#/components/schemas/ingest._types:JsonProcessorConflictStrategy" + "field": { + "$ref": "#/components/schemas/_types:Field" }, - "allow_duplicate_keys": { - "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.", + "first_only": { + "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", "type": "boolean" }, - "field": { - "$ref": "#/components/schemas/_types:Field" + "ignore_missing": { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "type": "boolean" + }, + "properties": { + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "type": "array", + "items": { + "type": "string" + } }, "target_field": { "$ref": "#/components/schemas/_types:Field" @@ -54005,14 +54120,7 @@ } ] }, - "ingest._types:JsonProcessorConflictStrategy": { - "type": "string", - "enum": [ - "replace", - "merge" - ] - }, - "ingest._types:UserAgentProcessor": { + "ingest._types:GrokProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54024,45 +54132,36 @@ "$ref": "#/components/schemas/_types:Field" }, "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "options": { + "pattern_definitions": { + "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.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "patterns": { + "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", "type": "array", "items": { - "$ref": "#/components/schemas/ingest._types:UserAgentProperty" + "type": "string" } }, - "regex_file": { - "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.", - "type": "string" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" + "trace_match": { + "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.", + "type": "boolean" } }, "required": [ - "field" + "field", + "patterns" ] } ] }, - "ingest._types:UserAgentProperty": { - "type": "string", - "enum": [ - "NAME", - "MAJOR", - "MINOR", - "PATCH", - "OS", - "OS_NAME", - "OS_MAJOR", - "OS_MINOR", - "DEVICE", - "BUILD" - ] - }, - "ingest._types:KeyValueProcessor": { + "ingest._types:GsubProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54070,64 +54169,34 @@ { "type": "object", "properties": { - "exclude_keys": { - "description": "List of keys to exclude from document.", - "type": "array", - "items": { - "type": "string" - } - }, "field": { "$ref": "#/components/schemas/_types:Field" }, - "field_split": { - "description": "Regex pattern to use for splitting key-value pairs.", - "type": "string" - }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "include_keys": { - "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", - "type": "array", - "items": { - "type": "string" - } - }, - "prefix": { - "description": "Prefix to be added to extracted keys.", + "pattern": { + "description": "The pattern to be replaced.", "type": "string" }, - "strip_brackets": { - "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", - "type": "boolean" + "replacement": { + "description": "The string to replace the matching patterns with.", + "type": "string" }, "target_field": { "$ref": "#/components/schemas/_types:Field" - }, - "trim_key": { - "description": "String of characters to trim from extracted keys.", - "type": "string" - }, - "trim_value": { - "description": "String of characters to trim from extracted values.", - "type": "string" - }, - "value_split": { - "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", - "type": "string" } }, "required": [ "field", - "field_split", - "value_split" + "pattern", + "replacement" ] } ] }, - "ingest._types:GeoIpProcessor": { + "ingest._types:InferenceProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54135,39 +54204,78 @@ { "type": "object", "properties": { - "database_file": { - "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.", - "type": "string" + "model_id": { + "$ref": "#/components/schemas/_types:Id" }, - "field": { + "target_field": { "$ref": "#/components/schemas/_types:Field" }, - "first_only": { - "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", - "type": "boolean" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "properties": { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", - "type": "array", - "items": { - "type": "string" + "field_map": { + "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.", + "type": "object", + "additionalProperties": { + "type": "object" } }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" + "inference_config": { + "$ref": "#/components/schemas/ingest._types:InferenceConfig" } }, "required": [ - "field" + "model_id" ] } ] }, - "ingest._types:GrokProcessor": { + "ingest._types:InferenceConfig": { + "type": "object", + "properties": { + "regression": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigRegression" + }, + "classification": { + "$ref": "#/components/schemas/ingest._types:InferenceConfigClassification" + } + }, + "minProperties": 1, + "maxProperties": 1 + }, + "ingest._types:InferenceConfigRegression": { + "type": "object", + "properties": { + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + } + } + }, + "ingest._types:InferenceConfigClassification": { + "type": "object", + "properties": { + "num_top_classes": { + "description": "Specifies the number of top class predictions to return.", + "type": "number" + }, + "num_top_feature_importance_values": { + "description": "Specifies the maximum number of feature importance values per document.", + "type": "number" + }, + "results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "top_classes_results_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "prediction_field_type": { + "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", + "type": "string" + } + } + }, + "ingest._types:JoinProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54178,37 +54286,61 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "type": "boolean" + "separator": { + "description": "The separator character.", + "type": "string" }, - "pattern_definitions": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "target_field": { + "$ref": "#/components/schemas/_types:Field" + } + }, + "required": [ + "field", + "separator" + ] + } + ] + }, + "ingest._types:JsonProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "add_to_root": { + "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.", + "type": "boolean" }, - "patterns": { - "description": "An ordered list of grok expression to match and extract named captures with.\nReturns on the first expression in the list that matches.", - "type": "array", - "items": { - "type": "string" - } + "add_to_root_conflict_strategy": { + "$ref": "#/components/schemas/ingest._types:JsonProcessorConflictStrategy" }, - "trace_match": { - "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.", + "allow_duplicate_keys": { + "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.", "type": "boolean" + }, + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "patterns" + "field" ] } ] }, - "ingest._types:GsubProcessor": { + "ingest._types:JsonProcessorConflictStrategy": { + "type": "string", + "enum": [ + "replace", + "merge" + ] + }, + "ingest._types:KeyValueProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54216,34 +54348,64 @@ { "type": "object", "properties": { + "exclude_keys": { + "description": "List of keys to exclude from document.", + "type": "array", + "items": { + "type": "string" + } + }, "field": { "$ref": "#/components/schemas/_types:Field" }, + "field_split": { + "description": "Regex pattern to use for splitting key-value pairs.", + "type": "string" + }, "ignore_missing": { "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", "type": "boolean" }, - "pattern": { - "description": "The pattern to be replaced.", - "type": "string" + "include_keys": { + "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", + "type": "array", + "items": { + "type": "string" + } }, - "replacement": { - "description": "The string to replace the matching patterns with.", + "prefix": { + "description": "Prefix to be added to extracted keys.", "type": "string" }, + "strip_brackets": { + "description": "If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `\"` from extracted values.", + "type": "boolean" + }, "target_field": { "$ref": "#/components/schemas/_types:Field" + }, + "trim_key": { + "description": "String of characters to trim from extracted keys.", + "type": "string" + }, + "trim_value": { + "description": "String of characters to trim from extracted values.", + "type": "string" + }, + "value_split": { + "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", + "type": "string" } }, "required": [ "field", - "pattern", - "replacement" + "field_split", + "value_split" ] } ] }, - "ingest._types:JoinProcessor": { + "ingest._types:LowercaseProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54254,22 +54416,21 @@ "field": { "$ref": "#/components/schemas/_types:Field" }, - "separator": { - "description": "The separator character.", - "type": "string" + "ignore_missing": { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "type": "boolean" }, "target_field": { "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field", - "separator" + "field" ] } ] }, - "ingest._types:LowercaseProcessor": { + "ingest._types:PipelineProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54277,19 +54438,16 @@ { "type": "object", "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" + "name": { + "$ref": "#/components/schemas/_types:Name" }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "ignore_missing_pipeline": { + "description": "Whether to ignore missing pipelines instead of failing.", "type": "boolean" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "field" + "name" ] } ] @@ -54456,6 +54614,31 @@ } ] }, + "ingest._types:SetSecurityUserProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "properties": { + "description": "Controls what user related properties are added to the field.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:SortProcessor": { "allOf": [ { @@ -54589,32 +54772,7 @@ } ] }, - "ingest._types:BytesProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "type": "boolean" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - } - }, - "required": [ - "field" - ] - } - ] - }, - "ingest._types:DissectProcessor": { + "ingest._types:UserAgentProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -54622,206 +54780,48 @@ { "type": "object", "properties": { - "append_separator": { - "description": "The character(s) that separate the appended fields.", - "type": "string" - }, "field": { "$ref": "#/components/schemas/_types:Field" }, "ignore_missing": { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "type": "boolean" }, - "pattern": { - "description": "The pattern to apply to the field.", - "type": "string" - } - }, - "required": [ - "field", - "pattern" - ] - } - ] - }, - "ingest._types:SetSecurityUserProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "properties": { - "description": "Controls what user related properties are added to the field.", + "options": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ingest._types:UserAgentProperty" } - } - }, - "required": [ - "field" - ] - } - ] - }, - "ingest._types:PipelineProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/_types:Name" - }, - "ignore_missing_pipeline": { - "description": "Whether to ignore missing pipelines instead of failing.", - "type": "boolean" - } - }, - "required": [ - "name" - ] - } - ] - }, - "ingest._types:DropProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object" - } - ] - }, - "ingest._types:CircleProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "error_distance": { - "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`).", - "type": "number" - }, - "field": { - "$ref": "#/components/schemas/_types:Field" - }, - "ignore_missing": { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "type": "boolean" }, - "shape_type": { - "$ref": "#/components/schemas/ingest._types:ShapeType" + "regex_file": { + "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.", + "type": "string" }, "target_field": { "$ref": "#/components/schemas/_types:Field" } }, "required": [ - "error_distance", - "field", - "shape_type" + "field" ] } ] }, - "ingest._types:ShapeType": { + "ingest._types:UserAgentProperty": { "type": "string", "enum": [ - "geo_shape", - "shape" - ] - }, - "ingest._types:InferenceProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "type": "object", - "properties": { - "model_id": { - "$ref": "#/components/schemas/_types:Id" - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "field_map": { - "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.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "inference_config": { - "$ref": "#/components/schemas/ingest._types:InferenceConfig" - } - }, - "required": [ - "model_id" - ] - } + "NAME", + "MAJOR", + "MINOR", + "PATCH", + "OS", + "OS_NAME", + "OS_MAJOR", + "OS_MINOR", + "DEVICE", + "BUILD" ] }, - "ingest._types:InferenceConfig": { - "type": "object", - "properties": { - "regression": { - "$ref": "#/components/schemas/ingest._types:InferenceConfigRegression" - }, - "classification": { - "$ref": "#/components/schemas/ingest._types:InferenceConfigClassification" - } - }, - "minProperties": 1, - "maxProperties": 1 - }, - "ingest._types:InferenceConfigRegression": { - "type": "object", - "properties": { - "results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "num_top_feature_importance_values": { - "description": "Specifies the maximum number of feature importance values per document.", - "type": "number" - } - } - }, - "ingest._types:InferenceConfigClassification": { - "type": "object", - "properties": { - "num_top_classes": { - "description": "Specifies the number of top class predictions to return.", - "type": "number" - }, - "num_top_feature_importance_values": { - "description": "Specifies the maximum number of feature importance values per document.", - "type": "number" - }, - "results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "top_classes_results_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "prediction_field_type": { - "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", - "type": "string" - } - } - }, "ingest.simulate:Document": { "type": "object", "properties": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index cb631d4dad..aee774c1ae 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -117492,6 +117492,20 @@ "namespace": "ingest._types" }, "properties": [ + { + "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": { + "kind": "instance_of", + "type": { + "name": "AppendProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -117507,29 +117521,29 @@ } }, { - "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", + "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `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": { "kind": "instance_of", "type": { - "name": "AppendProcessor", + "name": "BytesProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "CsvProcessor", + "name": "CircleProcessor", "namespace": "ingest._types" } } @@ -117548,6 +117562,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "CsvProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", "docId": "data-processor", @@ -117576,6 +117604,20 @@ } } }, + { + "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", + "docId": "dissect-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", + "name": "dissect", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DissectProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -117590,6 +117632,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "DropProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "The `enrich` processor can enrich documents with data from another index.", "docId": "enrich-processor", @@ -117633,99 +117689,99 @@ } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "JsonProcessor", + "name": "GeoIpProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "UserAgentProcessor", + "name": "GrokProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "KeyValueProcessor", + "name": "GsubProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GeoIpProcessor", + "name": "InferenceProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GrokProcessor", + "name": "JoinProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GsubProcessor", + "name": "JsonProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "JoinProcessor", + "name": "KeyValueProcessor", "namespace": "ingest._types" } } @@ -117744,6 +117800,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "PipelineProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", @@ -117814,6 +117884,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "SetSecurityUserProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -117885,109 +117969,150 @@ } }, { - "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `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", + "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": { "kind": "instance_of", "type": { - "name": "BytesProcessor", + "name": "UserAgentProcessor", "namespace": "ingest._types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L27-L239", + "variants": { + "kind": "container", + "nonExhaustive": true + } + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "AppendProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", - "docId": "dissect-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", - "name": "dissect", - "required": false, + "description": "The field to be appended to.\nSupports template snippets.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DissectProcessor", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } }, { - "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, + "description": "The value to be appended. Supports template snippets.", + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "SetSecurityUserProcessor", - "namespace": "ingest._types" + "kind": "array_of", + "value": { + "kind": "user_defined_value" } } }, { - "description": "Executes another pipeline.", - "docId": "pipeline-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html", - "name": "pipeline", + "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": { - "name": "PipelineProcessor", - "namespace": "ingest._types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L279-L294" + }, + { + "kind": "interface", + "name": { + "name": "ProcessorBase", + "namespace": "ingest._types" + }, + "properties": [ { - "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", + "description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DropProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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", + "description": "Conditionally execute the processor.", + "name": "if", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CircleProcessor", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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", + "description": "Ignore failures for the processor.", + "name": "ignore_failure", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InferenceProcessor", - "namespace": "ingest._types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Handle failures for the processor.", + "name": "on_failure", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "description": "Identifier for the processor.\nUseful for debugging and metrics.", + "name": "tag", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L239", - "variants": { - "kind": "container", - "nonExhaustive": true - } + "specLocation": "ingest/_types/Processors.ts#L241-L264" }, { "inherits": { @@ -118110,40 +118235,101 @@ "specLocation": "ingest/_types/Processors.ts#L296-L337" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "ProcessorBase", + "name": "BytesProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "Description of the processor.\nUseful for describing the purpose of the processor or its configuration.", - "name": "description", + "description": "The field to convert.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "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": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Conditionally execute the processor.", - "name": "if", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L392-L408" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "CircleProcessor", + "namespace": "ingest._types" + }, + "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": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "description": "Ignore failures for the processor.", - "name": "ignore_failure", + "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "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": { @@ -118153,34 +118339,31 @@ } }, { - "description": "Handle failures for the processor.", - "name": "on_failure", - "required": false, + "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.", + "name": "shape_type", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "ShapeType", + "namespace": "ingest._types" } } }, { - "description": "Identifier for the processor.\nUseful for debugging and metrics.", - "name": "tag", + "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L241-L264" + "specLocation": "ingest/_types/Processors.ts#L410-L433" }, { "inherits": { @@ -118191,12 +118374,12 @@ }, "kind": "interface", "name": { - "name": "AppendProcessor", + "name": "ConvertProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to be appended to.\nSupports template snippets.", + "description": "The field whose value is to be converted.", "name": "field", "required": true, "type": { @@ -118208,31 +118391,45 @@ } }, { - "description": "The value to be appended. Supports template snippets.", - "name": "value", - "required": true, + "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": "array_of", - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `false`, the processor does not append values already present in the field.", - "name": "allow_duplicates", + "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.", + "name": "target_field", "required": false, - "serverDefault": true, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The type to convert the existing value to.", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ConvertType", + "namespace": "ingest._types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L279-L294" + "specLocation": "ingest/_types/Processors.ts#L445-L465" }, { "inherits": { @@ -118341,12 +118538,12 @@ }, "kind": "interface", "name": { - "name": "ConvertProcessor", + "name": "DateProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field whose value is to be converted.", + "description": "The field to get the date from.", "name": "field", "required": true, "type": { @@ -118358,23 +118555,38 @@ } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "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": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "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": false, + "serverDefault": "ENGLISH", "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The field to assign the converted value to.\nBy default, the `field` is updated in-place.", + "description": "The field that will hold the parsed date.", "name": "target_field", "required": false, - "serverDefault": "field", + "serverDefault": "`@timestamp`", "type": { "kind": "instance_of", "type": { @@ -118384,19 +118596,20 @@ } }, { - "description": "The type to convert the existing value to.", - "name": "type", - "required": true, + "description": "The timezone to use when parsing the date.\nSupports template snippets.", + "name": "timezone", + "required": false, + "serverDefault": "UTC", "type": { "kind": "instance_of", "type": { - "name": "ConvertType", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "ingest/_types/Processors.ts#L445-L465" + "specLocation": "ingest/_types/Processors.ts#L542-L569" }, { "inherits": { @@ -118407,12 +118620,39 @@ }, "kind": "interface", "name": { - "name": "DateProcessor", + "name": "DateIndexNameProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to get the date from.", + "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": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.", + "name": "date_rounding", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The field to get the date or timestamp from.", "name": "field", "required": true, "type": { @@ -118424,25 +118664,22 @@ } }, { - "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, + "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": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The locale to use when parsing the date, relevant when parsing month names or week days.\nSupports template snippets.", - "name": "locale", + "description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.", + "name": "index_name_prefix", "required": false, - "serverDefault": "ENGLISH", "type": { "kind": "instance_of", "type": { @@ -118452,20 +118689,20 @@ } }, { - "description": "The field that will hold the parsed date.", - "name": "target_field", + "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": "`@timestamp`", + "serverDefault": "ENGLISH", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The timezone to use when parsing the date.\nSupports template snippets.", + "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", @@ -118478,7 +118715,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L542-L569" + "specLocation": "ingest/_types/Processors.ts#L502-L540" }, { "inherits": { @@ -118489,29 +118726,15 @@ }, "kind": "interface", "name": { - "name": "DateIndexNameProcessor", + "name": "DissectProcessor", "namespace": "ingest._types" }, "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": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "How to round the date when formatting the date into the index name. Valid values are:\n`y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).\nSupports template snippets.", - "name": "date_rounding", - "required": true, + "description": "The character(s) that separate the appended fields.", + "name": "append_separator", + "required": false, + "serverDefault": "\"\"", "type": { "kind": "instance_of", "type": { @@ -118521,7 +118744,7 @@ } }, { - "description": "The field to get the date or timestamp from.", + "description": "The field to dissect.", "name": "field", "required": true, "type": { @@ -118533,48 +118756,22 @@ } }, { - "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": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "A prefix of the index name to be prepended before the printed date.\nSupports template snippets.", - "name": "index_name_prefix", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.", - "name": "locale", + "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": "ENGLISH", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "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", + "description": "The pattern to apply to the field.", + "name": "pattern", + "required": true, "type": { "kind": "instance_of", "type": { @@ -118584,7 +118781,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L502-L540" + "specLocation": "ingest/_types/Processors.ts#L571-L590" }, { "inherits": { @@ -118626,6 +118823,21 @@ ], "specLocation": "ingest/_types/Processors.ts#L592-L603" }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "DropProcessor", + "namespace": "ingest._types" + }, + "properties": [], + "specLocation": "ingest/_types/Processors.ts#L605-L605" + }, { "inherits": { "type": { @@ -118820,40 +119032,40 @@ }, "kind": "interface", "name": { - "name": "JsonProcessor", + "name": "GeoIpProcessor", "namespace": "ingest._types" }, "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", + "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": false, + "serverDefault": "GeoLite2-City.mmdb", "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "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, + "description": "The field to get the ip address from for the geographical lookup.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "JsonProcessorConflictStrategy", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } }, { - "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", + "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", + "name": "first_only", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -118863,22 +119075,38 @@ } }, { - "description": "The field to be parsed.", - "name": "field", - "required": true, + "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": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The field that the converted structured object will be written into.\nAny existing content in this field will be overwritten.", + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "name": "properties", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "The field that will hold the geographical information looked up from the MaxMind database.", "name": "target_field", "required": false, - "serverDefault": "field", + "serverDefault": "geoip", "type": { "kind": "instance_of", "type": { @@ -118888,7 +119116,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L818-L847" + "specLocation": "ingest/_types/Processors.ts#L339-L368" }, { "inherits": { @@ -118899,12 +119127,12 @@ }, "kind": "interface", "name": { - "name": "UserAgentProcessor", + "name": "GrokProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field containing the user agent string.", + "description": "The field to use for grok expression parsing.", "name": "field", "required": true, "type": { @@ -118916,7 +119144,7 @@ } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "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, @@ -118929,380 +119157,48 @@ } }, { - "name": "options", + "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": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "UserAgentProperty", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } } }, { - "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, + "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": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The field that will be filled with the user agent details.", - "name": "target_field", + "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": "user_agent", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L370-L390" - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "KeyValueProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "List of keys to exclude from document.", - "name": "exclude_keys", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "The field to be parsed.\nSupports template snippets.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Regex pattern to use for splitting key-value pairs.", - "name": "field_split", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "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": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", - "name": "include_keys", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "Prefix to be added to extracted keys.", - "name": "prefix", - "required": false, - "serverDefault": "null", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "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": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "String of characters to trim from extracted keys.", - "name": "trim_key", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "String of characters to trim from extracted values.", - "name": "trim_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", - "name": "value_split", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L856-L908" - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "GeoIpProcessor", - "namespace": "ingest._types" - }, - "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": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The field to get the ip address from for the geographical lookup.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", - "name": "first_only", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", - "name": "properties", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "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": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L339-L368" - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "GrokProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "The field to use for grok expression parsing.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "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": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "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": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "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, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -119401,199 +119297,180 @@ }, "kind": "interface", "name": { - "name": "JoinProcessor", + "name": "InferenceProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "Field containing array values to join.", - "name": "field", + "description": "The ID or alias for the trained model, or the ID of the deployment.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "The separator character.", - "name": "separator", - "required": true, + "description": "Field added to incoming documents to contain results objects.", + "name": "target_field", + "required": false, + "serverDefault": "ml.inference.", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "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": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "Contains the inference type and its options.", + "name": "inference_config", "required": false, - "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "InferenceConfig", + "namespace": "ingest._types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L801-L816" + "specLocation": "ingest/_types/Processors.ts#L725-L744" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "LowercaseProcessor", + "name": "InferenceConfig", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to make lowercase.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Regression configuration for inference.", + "name": "regression", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "InferenceConfigRegression", + "namespace": "ingest._types" } } }, { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "description": "Classification configuration for inference.", + "name": "classification", "required": false, - "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "InferenceConfigClassification", + "namespace": "ingest._types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L926" + "specLocation": "ingest/_types/Processors.ts#L746-L758", + "variants": { + "kind": "container" + } }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "RemoveProcessor", + "name": "InferenceConfigRegression", "namespace": "ingest._types" }, "properties": [ { - "description": "Fields to be removed. Supports template snippets.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "description": "Fields to be kept. When set, all fields other than those specified are removed.", - "name": "keep", + "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": { - "name": "Fields", + "name": "Field", "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Specifies the maximum number of feature importance values per document.", + "name": "num_top_feature_importance_values", "required": false, - "serverDefault": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L941-L955" + "specLocation": "ingest/_types/Processors.ts#L760-L771" }, { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, "kind": "interface", "name": { - "name": "RenameProcessor", + "name": "InferenceConfigClassification", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to be renamed.\nSupports template snippets.", - "name": "field", - "required": true, + "description": "Specifies the number of top class predictions to return.", + "name": "num_top_classes", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Specifies the maximum number of feature importance values per document.", + "name": "num_top_feature_importance_values", "required": false, - "serverDefault": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The new name of the field.\nSupports template snippets.", - "name": "target_field", - "required": true, + "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": { @@ -119601,91 +119478,34 @@ "namespace": "_types" } } - } - ], - "specLocation": "ingest/_types/Processors.ts#L957-L973" - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "RerouteProcessor", - "namespace": "ingest._types" - }, - "properties": [ + }, { - "description": "A static value for the target. Can’t be set when the dataset or namespace option is set.", - "name": "destination", + "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": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}", - "name": "dataset", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}", - "name": "namespace", + "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", + "name": "prediction_field_type", "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "specLocation": "ingest/_types/Processors.ts#L975-L1003" + "specLocation": "ingest/_types/Processors.ts#L773-L799" }, { "inherits": { @@ -119696,27 +119516,26 @@ }, "kind": "interface", "name": { - "name": "ScriptProcessor", + "name": "JoinProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.", - "name": "id", - "required": false, + "description": "Field containing array values to join.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "description": "Script language.", - "name": "lang", - "required": false, - "serverDefault": "painless", + "description": "The separator character.", + "name": "separator", + "required": true, "type": { "kind": "instance_of", "type": { @@ -119726,38 +119545,20 @@ } }, { - "description": "Object containing parameters for the script.", - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "Inline script.\nIf no `id` is specified, this parameter is required.", - "name": "source", + "description": "The field to assign the joined value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L1005-L1025" + "specLocation": "ingest/_types/Processors.ts#L801-L816" }, { "inherits": { @@ -119768,37 +119569,38 @@ }, "kind": "interface", "name": { - "name": "SetProcessor", + "name": "JsonProcessor", "namespace": "ingest._types" }, "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", + "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": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The field to insert, upsert, or update.\nSupports template snippets.", - "name": "field", - "required": true, + "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": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "JsonProcessorConflictStrategy", + "namespace": "ingest._types" } } }, { - "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", + "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": { @@ -119810,40 +119612,32 @@ } }, { - "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, + "description": "The field to be parsed.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "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", + "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": true, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } - }, - { - "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": { - "kind": "user_defined_value" - } } ], - "specLocation": "ingest/_types/Processors.ts#L1027-L1061" + "specLocation": "ingest/_types/Processors.ts#L818-L847" }, { "inherits": { @@ -119854,12 +119648,27 @@ }, "kind": "interface", "name": { - "name": "SortProcessor", + "name": "KeyValueProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to be sorted.", + "description": "List of keys to exclude from document.", + "name": "exclude_keys", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "The field to be parsed.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -119871,20 +119680,73 @@ } }, { - "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", - "name": "order", + "description": "Regex pattern to use for splitting key-value pairs.", + "name": "field_split", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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": "asc", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "description": "List of keys to filter and insert into document.\nDefaults to including all keys.", + "name": "include_keys", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Prefix to be added to extracted keys.", + "name": "prefix", + "required": false, + "serverDefault": "null", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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": { @@ -119894,9 +119756,45 @@ "namespace": "_types" } } + }, + { + "description": "String of characters to trim from extracted keys.", + "name": "trim_key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "String of characters to trim from extracted values.", + "name": "trim_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Regex pattern to use for splitting the key from the value within a key-value pair.", + "name": "value_split", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "ingest/_types/Processors.ts#L1079-L1095" + "specLocation": "ingest/_types/Processors.ts#L856-L908" }, { "inherits": { @@ -119907,12 +119805,12 @@ }, "kind": "interface", "name": { - "name": "SplitProcessor", + "name": "LowercaseProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to split.", + "description": "The field to make lowercase.", "name": "field", "required": true, "type": { @@ -119924,7 +119822,7 @@ } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "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, @@ -119937,45 +119835,61 @@ } }, { - "description": "Preserves empty trailing fields, if any.", - "name": "preserve_trailing", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, - "serverDefault": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ingest/_types/Processors.ts#L910-L926" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "PipelineProcessor", + "namespace": "ingest._types" + }, + "properties": [ { - "description": "A regex which matches the separator, for example, `,` or `\\s+`.", - "name": "separator", + "description": "The name of the pipeline to execute.\nSupports template snippets.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "description": "Whether to ignore missing pipelines instead of failing.", + "name": "ignore_missing_pipeline", "required": false, - "serverDefault": "field", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ingest/_types/Processors.ts#L1097-L1122" + "specLocation": "ingest/_types/Processors.ts#L928-L939" }, { "inherits": { @@ -119986,50 +119900,49 @@ }, "kind": "interface", "name": { - "name": "TrimProcessor", + "name": "RemoveProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The string-valued field to trim whitespace from.", + "description": "Fields to be removed. Supports template snippets.", "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Fields", "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Fields to be kept. When set, all fields other than those specified are removed.", + "name": "keep", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Fields", + "namespace": "_types" } } }, { - "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "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": "field", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ingest/_types/Processors.ts#L1124-L1140" + "specLocation": "ingest/_types/Processors.ts#L941-L955" }, { "inherits": { @@ -120040,12 +119953,12 @@ }, "kind": "interface", "name": { - "name": "UppercaseProcessor", + "name": "RenameProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to make uppercase.", + "description": "The field to be renamed.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -120057,7 +119970,7 @@ } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", "name": "ignore_missing", "required": false, "serverDefault": false, @@ -120070,10 +119983,9 @@ } }, { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "description": "The new name of the field.\nSupports template snippets.", "name": "target_field", - "required": false, - "serverDefault": "field", + "required": true, "type": { "kind": "instance_of", "type": { @@ -120083,7 +119995,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1142-L1158" + "specLocation": "ingest/_types/Processors.ts#L957-L973" }, { "inherits": { @@ -120094,50 +120006,78 @@ }, "kind": "interface", "name": { - "name": "UrlDecodeProcessor", + "name": "RerouteProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to decode.", - "name": "field", - "required": true, + "description": "A static value for the target. Can’t be set when the dataset or namespace option is set.", + "name": "destination", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Field references or a static value for the dataset part of the data stream name.\nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters.\nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}", + "name": "dataset", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces).\nWhen resolving field references, the processor replaces invalid characters with _. Uses the part\nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}", + "name": "namespace", "required": false, - "serverDefault": "field", "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } } ], - "specLocation": "ingest/_types/Processors.ts#L1160-L1176" + "specLocation": "ingest/_types/Processors.ts#L975-L1003" }, { "inherits": { @@ -120148,50 +120088,68 @@ }, "kind": "interface", "name": { - "name": "BytesProcessor", + "name": "ScriptProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to convert.", - "name": "field", - "required": true, + "description": "ID of a stored script.\nIf no `source` is specified, this parameter is required.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Script language.", + "name": "lang", "required": false, - "serverDefault": false, + "serverDefault": "painless", "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", - "name": "target_field", + "description": "Object containing parameters for the script.", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "Inline script.\nIf no `id` is specified, this parameter is required.", + "name": "source", "required": false, - "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "ingest/_types/Processors.ts#L392-L408" + "specLocation": "ingest/_types/Processors.ts#L1005-L1025" }, { "inherits": { @@ -120202,25 +120160,24 @@ }, "kind": "interface", "name": { - "name": "DissectProcessor", + "name": "SetProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The character(s) that separate the appended fields.", - "name": "append_separator", + "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, - "serverDefault": "\"\"", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "The field to dissect.", + "description": "The field to insert, upsert, or update.\nSupports template snippets.", "name": "field", "required": true, "type": { @@ -120232,8 +120189,8 @@ } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "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": { @@ -120245,9 +120202,9 @@ } }, { - "description": "The pattern to apply to the field.", - "name": "pattern", - "required": true, + "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": { "kind": "instance_of", "type": { @@ -120255,9 +120212,30 @@ "namespace": "_builtins" } } + }, + { + "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": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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": { + "kind": "user_defined_value" + } } ], - "specLocation": "ingest/_types/Processors.ts#L571-L590" + "specLocation": "ingest/_types/Processors.ts#L1027-L1061" }, { "inherits": { @@ -120311,52 +120289,49 @@ }, "kind": "interface", "name": { - "name": "PipelineProcessor", + "name": "SortProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The name of the pipeline to execute.\nSupports template snippets.", - "name": "name", + "description": "The field to be sorted.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", + "name": "order", + "required": false, + "serverDefault": "asc", + "type": { + "kind": "instance_of", + "type": { + "name": "SortOrder", "namespace": "_types" } } }, { - "description": "Whether to ignore missing pipelines instead of failing.", - "name": "ignore_missing_pipeline", + "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L928-L939" - }, - { - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "kind": "interface", - "name": { - "name": "DropProcessor", - "namespace": "ingest._types" - }, - "properties": [], - "specLocation": "ingest/_types/Processors.ts#L605-L605" + "specLocation": "ingest/_types/Processors.ts#L1079-L1095" }, { "inherits": { @@ -120367,37 +120342,38 @@ }, "kind": "interface", "name": { - "name": "CircleProcessor", + "name": "SplitProcessor", "namespace": "ingest._types" }, "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", + "description": "The field to split.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Field", "namespace": "_types" } } }, { - "description": "The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.", - "name": "field", - "required": true, + "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": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "Preserves empty trailing fields, if any.", + "name": "preserve_trailing", "required": false, "serverDefault": false, "type": { @@ -120409,21 +120385,22 @@ } }, { - "description": "Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.", - "name": "shape_type", + "description": "A regex which matches the separator, for example, `,` or `\\s+`.", + "name": "separator", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShapeType", - "namespace": "ingest._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The field to assign the polygon shape to\nBy default, the field is updated in-place.", + "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -120433,7 +120410,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L410-L433" + "specLocation": "ingest/_types/Processors.ts#L1097-L1122" }, { "inherits": { @@ -120444,118 +120421,122 @@ }, "kind": "interface", "name": { - "name": "InferenceProcessor", + "name": "TrimProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The ID or alias for the trained model, or the ID of the deployment.", - "name": "model_id", + "description": "The string-valued field to trim whitespace from.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Field", "namespace": "_types" } } }, { - "description": "Field added to incoming documents to contain results objects.", - "name": "target_field", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "name": "ignore_missing", "required": false, - "serverDefault": "ml.inference.", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "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": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains the inference type and its options.", - "name": "inference_config", + "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "InferenceConfig", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L725-L744" + "specLocation": "ingest/_types/Processors.ts#L1124-L1140" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "InferenceConfig", + "name": "UppercaseProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "Regression configuration for inference.", - "name": "regression", + "description": "The field to make uppercase.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "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": { - "name": "InferenceConfigRegression", - "namespace": "ingest._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Classification configuration for inference.", - "name": "classification", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { - "name": "InferenceConfigClassification", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L746-L758", - "variants": { - "kind": "container" - } + "specLocation": "ingest/_types/Processors.ts#L1142-L1158" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "InferenceConfigRegression", + "name": "UrlDecodeProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field that is added to incoming documents to contain the inference prediction.", - "name": "results_field", - "required": false, - "serverDefault": "_prediction", + "description": "The field to decode.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { @@ -120565,94 +120546,113 @@ } }, { - "description": "Specifies the maximum number of feature importance values per document.", - "name": "num_top_feature_importance_values", + "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": 0, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", + "required": false, + "serverDefault": "field", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L760-L771" + "specLocation": "ingest/_types/Processors.ts#L1160-L1176" }, { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "kind": "interface", "name": { - "name": "InferenceConfigClassification", + "name": "UserAgentProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "Specifies the number of top class predictions to return.", - "name": "num_top_classes", - "required": false, - "serverDefault": 0, + "description": "The field containing the user agent string.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "description": "Specifies the maximum number of feature importance values per document.", - "name": "num_top_feature_importance_values", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "name": "ignore_missing", "required": false, - "serverDefault": 0, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The field that is added to incoming documents to contain the inference prediction.", - "name": "results_field", + "name": "options", "required": false, - "serverDefault": "_prediction", "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "UserAgentProperty", + "namespace": "ingest._types" + } } } }, { - "description": "Specifies the field to which the top classes are written.", - "name": "top_classes_results_field", + "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, - "serverDefault": "top_classes", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies the type of the predicted field to write.\nValid values are: `string`, `number`, `boolean`.", - "name": "prediction_field_type", + "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": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Processors.ts#L773-L799" + "specLocation": "ingest/_types/Processors.ts#L370-L390" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 4773a3b5a7..c64eee930d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -138730,6 +138730,20 @@ "namespace": "ingest._types" }, "properties": [ + { + "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": { + "kind": "instance_of", + "type": { + "name": "AppendProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -138745,29 +138759,29 @@ } }, { - "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", + "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `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": { "kind": "instance_of", "type": { - "name": "AppendProcessor", + "name": "BytesProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "CsvProcessor", + "name": "CircleProcessor", "namespace": "ingest._types" } } @@ -138786,6 +138800,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "CsvProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", "docId": "data-processor", @@ -138814,6 +138842,20 @@ } } }, + { + "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", + "docId": "dissect-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", + "name": "dissect", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DissectProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -138828,6 +138870,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "DropProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "The `enrich` processor can enrich documents with data from another index.", "docId": "enrich-processor", @@ -138871,99 +138927,99 @@ } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "JsonProcessor", + "name": "GeoIpProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "UserAgentProcessor", + "name": "GrokProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "KeyValueProcessor", + "name": "GsubProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GeoIpProcessor", + "name": "InferenceProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GrokProcessor", + "name": "JoinProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "GsubProcessor", + "name": "JsonProcessor", "namespace": "ingest._types" } } }, { - "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", + "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": { "kind": "instance_of", "type": { - "name": "JoinProcessor", + "name": "KeyValueProcessor", "namespace": "ingest._types" } } @@ -138982,6 +139038,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "PipelineProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", @@ -139052,6 +139122,20 @@ } } }, + { + "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": { + "kind": "instance_of", + "type": { + "name": "SetSecurityUserProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -139123,99 +139207,15 @@ } }, { - "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `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": { - "kind": "instance_of", - "type": { - "name": "BytesProcessor", - "namespace": "ingest._types" - } - } - }, - { - "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", - "docId": "dissect-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", - "name": "dissect", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DissectProcessor", - "namespace": "ingest._types" - } - } - }, - { - "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": { - "kind": "instance_of", - "type": { - "name": "SetSecurityUserProcessor", - "namespace": "ingest._types" - } - } - }, - { - "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": { - "kind": "instance_of", - "type": { - "name": "PipelineProcessor", - "namespace": "ingest._types" - } - } - }, - { - "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": { - "kind": "instance_of", - "type": { - "name": "DropProcessor", - "namespace": "ingest._types" - } - } - }, - { - "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": { - "kind": "instance_of", - "type": { - "name": "CircleProcessor", - "namespace": "ingest._types" - } - } - }, - { - "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", + "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": { "kind": "instance_of", "type": { - "name": "InferenceProcessor", + "name": "UserAgentProcessor", "namespace": "ingest._types" } } diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 4497dfab5e..50cfb46222 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12440,41 +12440,41 @@ export interface IngestProcessorBase { } export interface IngestProcessorContainer { - attachment?: IngestAttachmentProcessor append?: IngestAppendProcessor - csv?: IngestCsvProcessor + attachment?: IngestAttachmentProcessor + bytes?: IngestBytesProcessor + circle?: IngestCircleProcessor convert?: IngestConvertProcessor + csv?: IngestCsvProcessor date?: IngestDateProcessor date_index_name?: IngestDateIndexNameProcessor + dissect?: IngestDissectProcessor dot_expander?: IngestDotExpanderProcessor + drop?: IngestDropProcessor enrich?: IngestEnrichProcessor fail?: IngestFailProcessor foreach?: IngestForeachProcessor - json?: IngestJsonProcessor - user_agent?: IngestUserAgentProcessor - kv?: IngestKeyValueProcessor geoip?: IngestGeoIpProcessor grok?: IngestGrokProcessor gsub?: IngestGsubProcessor + inference?: IngestInferenceProcessor join?: IngestJoinProcessor + json?: IngestJsonProcessor + kv?: IngestKeyValueProcessor lowercase?: IngestLowercaseProcessor + pipeline?: IngestPipelineProcessor remove?: IngestRemoveProcessor rename?: IngestRenameProcessor reroute?: IngestRerouteProcessor script?: IngestScriptProcessor set?: IngestSetProcessor + set_security_user?: IngestSetSecurityUserProcessor sort?: IngestSortProcessor split?: IngestSplitProcessor trim?: IngestTrimProcessor uppercase?: IngestUppercaseProcessor urldecode?: IngestUrlDecodeProcessor - bytes?: IngestBytesProcessor - dissect?: IngestDissectProcessor - set_security_user?: IngestSetSecurityUserProcessor - pipeline?: IngestPipelineProcessor - drop?: IngestDropProcessor - circle?: IngestCircleProcessor - inference?: IngestInferenceProcessor + user_agent?: IngestUserAgentProcessor } export interface IngestRemoveProcessor extends IngestProcessorBase { diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index f6df66d73c..6acb0eb1a3 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -29,11 +29,6 @@ import { double, integer, long } from '@_types/Numeric' * @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. @@ -43,17 +38,35 @@ export class ProcessorContainer { */ 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 + * 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 */ - csv?: CsvProcessor + attachment?: AttachmentProcessor + /** + * 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 + /** + * Converts circle definitions of shapes to regular polygons which approximate them. + * @doc_id ingest-circle-processor + */ + circle?: CircleProcessor /** * 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 + /** + * 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 /** * Parses dates from fields, and then uses the date or timestamp as the timestamp for the document. * @doc_id data-processor @@ -64,6 +77,11 @@ export class ProcessorContainer { * @doc_id date-index-name-processor */ date_index_name?: DateIndexNameProcessor + /** + * 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 /** * 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. @@ -71,6 +89,12 @@ export class ProcessorContainer { * @doc_id dot-expand-processor */ dot_expander?: DotExpanderProcessor + /** + * 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 /** * The `enrich` processor can enrich documents with data from another index. * @doc_id enrich-processor @@ -87,22 +111,6 @@ export class ProcessorContainer { * @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 @@ -122,18 +130,38 @@ export class ProcessorContainer { * @doc_id gsub-processor */ gsub?: GsubProcessor + /** + * 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 /** * 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 JSON string into a structured JSON object. + * @doc_id json-processor + */ + json?: JsonProcessor + /** + * This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. + * @doc_id kv-processor + */ + kv?: KeyValueProcessor /** * 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 + /** + * Executes another pipeline. + * @doc_id pipeline-processor + */ + pipeline?: PipelineProcessor /** * Removes existing fields. * If one field doesn’t exist, an exception will be thrown. @@ -165,6 +193,11 @@ export class ProcessorContainer { * @doc_id set-processor */ set?: SetProcessor + /** + * 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 /** * 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. @@ -198,44 +231,11 @@ export class ProcessorContainer { */ 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 + * 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 */ - inference?: InferenceProcessor + user_agent?: UserAgentProcessor } export class ProcessorBase {