Skip to content

Commit 74e6de1

Browse files
elasticsearch-specification update
Update code based on https://github.com/elastic/elasticsearch-specification/blob/main/output/schema/schema.json from Tue Jul 16 13:55:27 UTC 2024.
1 parent 2986460 commit 74e6de1

File tree

2 files changed

+61
-57
lines changed

2 files changed

+61
-57
lines changed

elasticsearch-ingest-node.schema.json

Lines changed: 48 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1278,22 +1278,30 @@
12781278
},
12791279
"ProcessorContainer": {
12801280
"properties": {
1281+
"append": {
1282+
"$ref": "#/$defs/AppendProcessor",
1283+
"description": "Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values."
1284+
},
12811285
"attachment": {
12821286
"$ref": "#/$defs/AttachmentProcessor",
12831287
"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."
12841288
},
1285-
"append": {
1286-
"$ref": "#/$defs/AppendProcessor",
1287-
"description": "Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values."
1289+
"bytes": {
1290+
"$ref": "#/$defs/BytesProcessor",
1291+
"description": "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."
12881292
},
1289-
"csv": {
1290-
"$ref": "#/$defs/CsvProcessor",
1291-
"description": "Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped."
1293+
"circle": {
1294+
"$ref": "#/$defs/CircleProcessor",
1295+
"description": "Converts circle definitions of shapes to regular polygons which approximate them."
12921296
},
12931297
"convert": {
12941298
"$ref": "#/$defs/ConvertProcessor",
12951299
"description": "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."
12961300
},
1301+
"csv": {
1302+
"$ref": "#/$defs/CsvProcessor",
1303+
"description": "Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped."
1304+
},
12971305
"date": {
12981306
"$ref": "#/$defs/DateProcessor",
12991307
"description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document."
@@ -1302,10 +1310,18 @@
13021310
"$ref": "#/$defs/DateIndexNameProcessor",
13031311
"description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support."
13041312
},
1313+
"dissect": {
1314+
"$ref": "#/$defs/DissectProcessor",
1315+
"description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."
1316+
},
13051317
"dot_expander": {
13061318
"$ref": "#/$defs/DotExpanderProcessor",
13071319
"description": "Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor."
13081320
},
1321+
"drop": {
1322+
"$ref": "#/$defs/DropProcessor",
1323+
"description": "Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition."
1324+
},
13091325
"enrich": {
13101326
"$ref": "#/$defs/EnrichProcessor",
13111327
"description": "The `enrich` processor can enrich documents with data from another index."
@@ -1318,18 +1334,6 @@
13181334
"$ref": "#/$defs/ForeachProcessor",
13191335
"description": "Runs an ingest processor on each element of an array or object."
13201336
},
1321-
"json": {
1322-
"$ref": "#/$defs/JsonProcessor",
1323-
"description": "Converts a JSON string into a structured JSON object."
1324-
},
1325-
"user_agent": {
1326-
"$ref": "#/$defs/UserAgentProcessor",
1327-
"description": "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."
1328-
},
1329-
"kv": {
1330-
"$ref": "#/$defs/KeyValueProcessor",
1331-
"description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."
1332-
},
13331337
"geoip": {
13341338
"$ref": "#/$defs/GeoIpProcessor",
13351339
"description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address."
@@ -1342,14 +1346,30 @@
13421346
"$ref": "#/$defs/GsubProcessor",
13431347
"description": "Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception."
13441348
},
1349+
"inference": {
1350+
"$ref": "#/$defs/InferenceProcessor",
1351+
"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."
1352+
},
13451353
"join": {
13461354
"$ref": "#/$defs/JoinProcessor",
13471355
"description": "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."
13481356
},
1357+
"json": {
1358+
"$ref": "#/$defs/JsonProcessor",
1359+
"description": "Converts a JSON string into a structured JSON object."
1360+
},
1361+
"kv": {
1362+
"$ref": "#/$defs/KeyValueProcessor",
1363+
"description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."
1364+
},
13491365
"lowercase": {
13501366
"$ref": "#/$defs/LowercaseProcessor",
13511367
"description": "Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted."
13521368
},
1369+
"pipeline": {
1370+
"$ref": "#/$defs/PipelineProcessor",
1371+
"description": "Executes another pipeline."
1372+
},
13531373
"remove": {
13541374
"$ref": "#/$defs/RemoveProcessor",
13551375
"description": "Removes existing fields. If one field doesn’t exist, an exception will be thrown."
@@ -1370,6 +1390,10 @@
13701390
"$ref": "#/$defs/SetProcessor",
13711391
"description": "Adds a field with the specified value. If the field already exists, its value will be replaced with the provided one."
13721392
},
1393+
"set_security_user": {
1394+
"$ref": "#/$defs/SetSecurityUserProcessor",
1395+
"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."
1396+
},
13731397
"sort": {
13741398
"$ref": "#/$defs/SortProcessor",
13751399
"description": "Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array."
@@ -1390,33 +1414,9 @@
13901414
"$ref": "#/$defs/UrlDecodeProcessor",
13911415
"description": "URL-decodes a string. If the field is an array of strings, all members of the array will be decoded."
13921416
},
1393-
"bytes": {
1394-
"$ref": "#/$defs/BytesProcessor",
1395-
"description": "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."
1396-
},
1397-
"dissect": {
1398-
"$ref": "#/$defs/DissectProcessor",
1399-
"description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."
1400-
},
1401-
"set_security_user": {
1402-
"$ref": "#/$defs/SetSecurityUserProcessor",
1403-
"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."
1404-
},
1405-
"pipeline": {
1406-
"$ref": "#/$defs/PipelineProcessor",
1407-
"description": "Executes another pipeline."
1408-
},
1409-
"drop": {
1410-
"$ref": "#/$defs/DropProcessor",
1411-
"description": "Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition."
1412-
},
1413-
"circle": {
1414-
"$ref": "#/$defs/CircleProcessor",
1415-
"description": "Converts circle definitions of shapes to regular polygons which approximate them."
1416-
},
1417-
"inference": {
1418-
"$ref": "#/$defs/InferenceProcessor",
1419-
"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."
1417+
"user_agent": {
1418+
"$ref": "#/$defs/UserAgentProcessor",
1419+
"description": "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."
14201420
}
14211421
},
14221422
"additionalProperties": false,
@@ -1450,6 +1450,9 @@
14501450
"field": {
14511451
"description": "Fields to be removed. Supports template snippets. Required."
14521452
},
1453+
"keep": {
1454+
"description": "Fields to be kept. When set, all fields other than those specified are removed."
1455+
},
14531456
"ignore_missing": {
14541457
"type": "boolean",
14551458
"description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document."

0 commit comments

Comments
 (0)