From 6040b3ad1b75cc0afb148d393712e91609400609 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Tue, 5 Nov 2024 11:50:42 +0400 Subject: [PATCH 1/2] Add undocumented ip_location ingest processor --- output/openapi/elasticsearch-openapi.json | 91 +++--- .../elasticsearch-serverless-openapi.json | 91 +++--- output/schema/schema-serverless.json | 288 +++++++++--------- output/schema/schema.json | 124 ++++---- output/typescript/types.ts | 1 + specification/ingest/_types/Processors.ts | 4 + 6 files changed, 317 insertions(+), 282 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 1c59a44a47..e1af7968f2 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -69729,6 +69729,9 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, + "ip_location": { + "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" + }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" }, @@ -70419,6 +70422,50 @@ } ] }, + "ingest._types:GeoIpProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "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" + }, + "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" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "download_database_on_pipeline_creation": { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:GeoGridProcessor": { "allOf": [ { @@ -70479,50 +70526,6 @@ "wkt" ] }, - "ingest._types:GeoIpProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "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" - }, - "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" - } - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "download_database_on_pipeline_creation": { - "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", - "type": "boolean" - } - }, - "required": [ - "field" - ] - } - ] - }, "ingest._types:GrokProcessor": { "allOf": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 9fd43d2948..4a74507b95 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -45820,6 +45820,9 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, + "ip_location": { + "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" + }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" }, @@ -46510,6 +46513,50 @@ } ] }, + "ingest._types:GeoIpProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "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" + }, + "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" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "download_database_on_pipeline_creation": { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:GeoGridProcessor": { "allOf": [ { @@ -46570,50 +46617,6 @@ "wkt" ] }, - "ingest._types:GeoIpProcessor": { - "allOf": [ - { - "$ref": "#/components/schemas/ingest._types:ProcessorBase" - }, - { - "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" - }, - "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" - } - }, - "target_field": { - "$ref": "#/components/schemas/_types:Field" - }, - "download_database_on_pipeline_creation": { - "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", - "type": "boolean" - } - }, - "required": [ - "field" - ] - } - ] - }, "ingest._types:GrokProcessor": { "allOf": [ { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 64f336a60f..626355084b 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -94595,7 +94595,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L625-L634" }, { "kind": "enum", @@ -94625,7 +94625,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L860-L866" }, { "kind": "enum", @@ -94641,7 +94641,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -94660,7 +94660,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "enum", @@ -94678,7 +94678,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1115-L1120" }, { "kind": "enum", @@ -94694,7 +94694,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1437-L1440" }, { "kind": "enum", @@ -94719,7 +94719,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L507-L513" + "specLocation": "ingest/_types/Processors.ts#L511-L517" }, { "kind": "enum", @@ -121178,6 +121178,18 @@ } } }, + { + "description": "Currently an undocumented alias for GeoIP Processor.", + "name": "ip_location", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoIpProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", "docId": "geo-grid-processor", @@ -121569,7 +121581,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -121633,7 +121645,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -121706,7 +121718,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "inherits": { @@ -121826,7 +121838,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "inherits": { @@ -121880,7 +121892,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L519-L535" }, { "inherits": { @@ -121957,7 +121969,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L537-L560" }, { "inherits": { @@ -122116,7 +122128,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L562-L623" }, { "inherits": { @@ -122182,7 +122194,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L636-L656" }, { "inherits": { @@ -122280,7 +122292,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L658-L691" }, { "inherits": { @@ -122375,7 +122387,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L733-L766" }, { "inherits": { @@ -122481,7 +122493,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L693-L731" }, { "inherits": { @@ -122547,7 +122559,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L768-L787" }, { "inherits": { @@ -122600,7 +122612,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L789-L807" }, { "inherits": { @@ -122615,7 +122627,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L809-L809" }, { "inherits": { @@ -122719,7 +122731,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L811-L850" }, { "inherits": { @@ -122747,7 +122759,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L852-L858" }, { "inherits": { @@ -122826,7 +122838,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L868-L896" }, { "inherits": { @@ -122879,7 +122891,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L908" + "specLocation": "ingest/_types/Processors.ts#L898-L912" }, { "inherits": { @@ -122890,14 +122902,15 @@ }, "kind": "interface", "name": { - "name": "GeoGridProcessor", + "name": "GeoIpProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`.", - "name": "field", - "required": true, + "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": { @@ -122907,22 +122920,9 @@ } }, { - "description": "Three tile formats are understood: geohash, geotile and geohex.", - "name": "tile_type", + "description": "The field to get the ip address from for the geographical lookup.", + "name": "field", "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoGridTileType", - "namespace": "ingest._types" - } - } - }, - { - "description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.", - "name": "target_field", - "required": false, - "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -122932,45 +122932,51 @@ } }, { - "description": "If specified and a parent tile exists, save that tile address to this field.", - "name": "parent_field", + "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": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.", - "name": "children_field", + "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 specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.", - "name": "non_children_field", + "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "name": "properties", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "If specified, save the tile precision (zoom) as an integer to this field.", - "name": "precision_field", + "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": { @@ -122980,10 +122986,9 @@ } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "name": "download_database_on_pipeline_creation", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -122991,22 +122996,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Which format to save the generated polygon in.", - "name": "target_format", - "required": false, - "serverDefault": "geojson", - "type": { - "kind": "instance_of", - "type": { - "name": "GeoGridTargetFormat", - "namespace": "ingest._types" - } - } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "inherits": { @@ -123017,15 +123009,14 @@ }, "kind": "interface", "name": { - "name": "GeoIpProcessor", + "name": "GeoGridProcessor", "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", + "description": "The field to interpret as a geo-tile.=\nThe field format is determined by the `tile_type`.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { @@ -123035,9 +123026,22 @@ } }, { - "description": "The field to get the ip address from for the geographical lookup.", - "name": "field", + "description": "Three tile formats are understood: geohash, geotile and geohex.", + "name": "tile_type", "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoGridTileType", + "namespace": "ingest._types" + } + } + }, + { + "description": "The field to assign the polygon shape to, by default, the `field` is updated in-place.", + "name": "target_field", + "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -123047,51 +123051,45 @@ } }, { - "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", - "name": "first_only", + "description": "If specified and a parent tile exists, save that tile address to this field.", + "name": "parent_field", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", + "description": "If specified and children tiles exist, save those tile addresses to this field as an array of strings.", + "name": "children_field", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", - "name": "properties", + "description": "If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.", + "name": "non_children_field", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } }, { - "description": "The field that will hold the geographical information looked up from the MaxMind database.", - "name": "target_field", + "description": "If specified, save the tile precision (zoom) as an integer to this field.", + "name": "precision_field", "required": false, - "serverDefault": "geoip", "type": { "kind": "instance_of", "type": { @@ -123101,9 +123099,10 @@ } }, { - "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", - "name": "download_database_on_pipeline_creation", + "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": { @@ -123111,9 +123110,22 @@ "namespace": "_builtins" } } + }, + { + "description": "Which format to save the generated polygon in.", + "name": "target_format", + "required": false, + "serverDefault": "geojson", + "type": { + "kind": "instance_of", + "type": { + "name": "GeoGridTargetFormat", + "namespace": "ingest._types" + } + } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "inherits": { @@ -123218,7 +123230,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L914-L945" }, { "inherits": { @@ -123296,7 +123308,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L947-L971" }, { "inherits": { @@ -123350,7 +123362,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L973-L989" }, { "inherits": { @@ -123422,7 +123434,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L987-L1006" + "specLocation": "ingest/_types/Processors.ts#L991-L1010" }, { "kind": "interface", @@ -123456,7 +123468,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1012-L1024", "variants": { "kind": "container" } @@ -123495,7 +123507,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1026-L1037" }, { "kind": "interface", @@ -123569,7 +123581,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1039-L1065" }, { "inherits": { @@ -123622,7 +123634,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1067-L1082" }, { "inherits": { @@ -123701,7 +123713,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1084-L1113" }, { "inherits": { @@ -123858,7 +123870,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1122-L1174" }, { "inherits": { @@ -123912,7 +123924,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1176-L1192" }, { "inherits": { @@ -124007,7 +124019,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1194-L1228" }, { "inherits": { @@ -124048,7 +124060,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1230-L1241" }, { "inherits": { @@ -124184,7 +124196,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1243-L1284" }, { "inherits": { @@ -124237,7 +124249,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1286-L1302" }, { "inherits": { @@ -124290,7 +124302,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1304-L1318" }, { "inherits": { @@ -124343,7 +124355,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1320-L1336" }, { "inherits": { @@ -124425,7 +124437,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1338-L1366" }, { "inherits": { @@ -124497,7 +124509,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1368-L1388" }, { "inherits": { @@ -124583,7 +124595,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1390-L1424" }, { "inherits": { @@ -124626,7 +124638,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1426-L1435" }, { "inherits": { @@ -124679,7 +124691,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1442-L1458" }, { "inherits": { @@ -124758,7 +124770,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1460-L1485" }, { "inherits": { @@ -124773,7 +124785,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1487-L1487" }, { "inherits": { @@ -124827,7 +124839,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1489-L1505" }, { "inherits": { @@ -124881,7 +124893,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1507-L1523" }, { "inherits": { @@ -124935,7 +124947,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "inherits": { @@ -125015,7 +125027,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1543-L1569" }, { "inherits": { @@ -125128,7 +125140,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L474-L505" + "specLocation": "ingest/_types/Processors.ts#L478-L509" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index cd19847cfb..57a215463f 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -141345,7 +141345,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -141465,7 +141465,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "kind": "interface", @@ -141519,7 +141519,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L519-L535" }, { "kind": "interface", @@ -141596,7 +141596,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L537-L560" }, { "kind": "interface", @@ -141755,7 +141755,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L562-L623" }, { "kind": "interface", @@ -141821,7 +141821,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L636-L656" }, { "kind": "enum", @@ -141855,7 +141855,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L625-L634" }, { "kind": "interface", @@ -141953,7 +141953,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L658-L691" }, { "kind": "interface", @@ -142093,7 +142093,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L693-L731" }, { "kind": "interface", @@ -142188,7 +142188,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L733-L766" }, { "kind": "interface", @@ -142254,7 +142254,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L768-L787" }, { "kind": "interface", @@ -142307,7 +142307,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L789-L807" }, { "kind": "interface", @@ -142322,7 +142322,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L809-L809" }, { "kind": "interface", @@ -142426,7 +142426,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L811-L850" }, { "kind": "interface", @@ -142454,7 +142454,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L852-L858" }, { "kind": "enum", @@ -142484,7 +142484,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L860-L866" }, { "kind": "interface", @@ -142563,7 +142563,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L868-L896" }, { "kind": "interface", @@ -142616,7 +142616,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L908" + "specLocation": "ingest/_types/Processors.ts#L898-L912" }, { "kind": "interface", @@ -142743,7 +142743,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "kind": "enum", @@ -142759,7 +142759,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -142778,7 +142778,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "interface", @@ -142885,7 +142885,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "kind": "interface", @@ -142990,7 +142990,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L914-L945" }, { "kind": "interface", @@ -143068,7 +143068,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L947-L971" }, { "kind": "interface", @@ -143122,7 +143122,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L973-L989" }, { "kind": "interface", @@ -143156,7 +143156,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1012-L1024", "variants": { "kind": "container" } @@ -143233,7 +143233,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1039-L1065" }, { "kind": "interface", @@ -143269,7 +143269,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1026-L1037" }, { "kind": "interface", @@ -143341,7 +143341,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L987-L1006" + "specLocation": "ingest/_types/Processors.ts#L991-L1010" }, { "kind": "interface", @@ -143394,7 +143394,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1067-L1082" }, { "kind": "interface", @@ -143473,7 +143473,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1084-L1113" }, { "kind": "enum", @@ -143491,7 +143491,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1115-L1120" }, { "kind": "interface", @@ -143648,7 +143648,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1122-L1174" }, { "kind": "interface", @@ -143702,7 +143702,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1176-L1192" }, { "kind": "interface", @@ -143818,7 +143818,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1194-L1228" }, { "kind": "interface", @@ -143997,7 +143997,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1230-L1241" }, { "kind": "interface", @@ -144070,7 +144070,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "kind": "interface", @@ -144303,6 +144303,18 @@ } } }, + { + "description": "Currently an undocumented alias for GeoIP Processor.", + "name": "ip_location", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoIpProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", "docId": "geo-grid-processor", @@ -144694,7 +144706,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -144834,7 +144846,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1243-L1284" }, { "kind": "interface", @@ -144887,7 +144899,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1286-L1302" }, { "kind": "interface", @@ -144940,7 +144952,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1304-L1318" }, { "kind": "interface", @@ -144993,7 +145005,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1320-L1336" }, { "kind": "interface", @@ -145075,7 +145087,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1338-L1366" }, { "kind": "interface", @@ -145147,7 +145159,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1368-L1388" }, { "kind": "interface", @@ -145233,7 +145245,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1390-L1424" }, { "kind": "interface", @@ -145276,7 +145288,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1426-L1435" }, { "kind": "enum", @@ -145292,7 +145304,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1437-L1440" }, { "kind": "interface", @@ -145345,7 +145357,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1442-L1458" }, { "kind": "interface", @@ -145424,7 +145436,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1460-L1485" }, { "kind": "interface", @@ -145439,7 +145451,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1487-L1487" }, { "kind": "interface", @@ -145493,7 +145505,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1489-L1505" }, { "kind": "interface", @@ -145547,7 +145559,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1507-L1523" }, { "kind": "interface", @@ -145627,7 +145639,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1543-L1569" }, { "kind": "interface", @@ -145681,7 +145693,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "kind": "interface", @@ -145794,7 +145806,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L474-L505" + "specLocation": "ingest/_types/Processors.ts#L478-L509" }, { "kind": "enum", @@ -145819,7 +145831,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L507-L513" + "specLocation": "ingest/_types/Processors.ts#L511-L517" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 9de8d27319..e626209a8a 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -13087,6 +13087,7 @@ export interface IngestProcessorContainer { fail?: IngestFailProcessor fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor + ip_location?: IngestGeoIpProcessor geo_grid?: IngestGeoGridProcessor geoip?: IngestGeoIpProcessor grok?: IngestGrokProcessor diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index 33402841a9..c1a5f54f78 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -124,6 +124,10 @@ export class ProcessorContainer { * @doc_id foreach-processor */ foreach?: ForeachProcessor + /** + * Currently an undocumented alias for GeoIP Processor. + */ + ip_location?: GeoIpProcessor /** * Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. * This is useful if there is a need to interact with the tile shapes as spatially indexable fields. From c3eeafd2727db3529ea134f018770d6900eecbfa Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 8 Nov 2024 11:59:46 +0400 Subject: [PATCH 2/2] Fix ip_location processor class name --- output/openapi/elasticsearch-openapi.json | 52 ++++- .../elasticsearch-serverless-openapi.json | 52 ++++- output/schema/schema-serverless.json | 213 +++++++++++++----- output/schema/schema.json | 205 +++++++++++++---- output/typescript/types.ts | 12 +- specification/ingest/_types/Processors.ts | 38 +++- 6 files changed, 460 insertions(+), 112 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e1af7968f2..077af59cb0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -69730,7 +69730,7 @@ "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, "ip_location": { - "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" + "$ref": "#/components/schemas/ingest._types:IpLocationProcessor" }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" @@ -70422,7 +70422,7 @@ } ] }, - "ingest._types:GeoIpProcessor": { + "ingest._types:IpLocationProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -70438,7 +70438,7 @@ "$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.", + "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", "type": "boolean" }, "ignore_missing": { @@ -70446,7 +70446,7 @@ "type": "boolean" }, "properties": { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "description": "Controls what properties are added to the `target_field` based on the IP location lookup.", "type": "array", "items": { "type": "string" @@ -70526,6 +70526,50 @@ "wkt" ] }, + "ingest._types:GeoIpProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "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" + }, + "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" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "download_database_on_pipeline_creation": { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:GrokProcessor": { "allOf": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 4a74507b95..4c67aa43f0 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -45821,7 +45821,7 @@ "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, "ip_location": { - "$ref": "#/components/schemas/ingest._types:GeoIpProcessor" + "$ref": "#/components/schemas/ingest._types:IpLocationProcessor" }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" @@ -46513,7 +46513,7 @@ } ] }, - "ingest._types:GeoIpProcessor": { + "ingest._types:IpLocationProcessor": { "allOf": [ { "$ref": "#/components/schemas/ingest._types:ProcessorBase" @@ -46529,7 +46529,7 @@ "$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.", + "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", "type": "boolean" }, "ignore_missing": { @@ -46537,7 +46537,7 @@ "type": "boolean" }, "properties": { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "description": "Controls what properties are added to the `target_field` based on the IP location lookup.", "type": "array", "items": { "type": "string" @@ -46617,6 +46617,50 @@ "wkt" ] }, + "ingest._types:GeoIpProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "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" + }, + "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" + } + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "download_database_on_pipeline_creation": { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:GrokProcessor": { "allOf": [ { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 626355084b..a6a6ab30e1 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -94595,7 +94595,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L625-L634" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "enum", @@ -94625,7 +94625,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L860-L866" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "enum", @@ -94678,7 +94678,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1115-L1120" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "enum", @@ -94694,7 +94694,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1437-L1440" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "enum", @@ -94719,7 +94719,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L511-L517" + "specLocation": "ingest/_types/Processors.ts#L547-L553" }, { "kind": "enum", @@ -121185,7 +121185,7 @@ "type": { "kind": "instance_of", "type": { - "name": "GeoIpProcessor", + "name": "IpLocationProcessor", "namespace": "ingest._types" } } @@ -121892,7 +121892,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L519-L535" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "inherits": { @@ -121969,7 +121969,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L537-L560" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "inherits": { @@ -122128,7 +122128,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L562-L623" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "inherits": { @@ -122194,7 +122194,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L636-L656" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "inherits": { @@ -122292,7 +122292,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L658-L691" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "inherits": { @@ -122387,7 +122387,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L733-L766" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "inherits": { @@ -122493,7 +122493,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L693-L731" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "inherits": { @@ -122559,7 +122559,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L768-L787" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "inherits": { @@ -122612,7 +122612,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L789-L807" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "inherits": { @@ -122627,7 +122627,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L809-L809" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "inherits": { @@ -122731,7 +122731,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L811-L850" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "inherits": { @@ -122759,7 +122759,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L852-L858" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "inherits": { @@ -122838,7 +122838,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L868-L896" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "inherits": { @@ -122891,7 +122891,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L898-L912" + "specLocation": "ingest/_types/Processors.ts#L934-L948" }, { "inherits": { @@ -122902,7 +122902,7 @@ }, "kind": "interface", "name": { - "name": "GeoIpProcessor", + "name": "IpLocationProcessor", "namespace": "ingest._types" }, "properties": [ @@ -122932,7 +122932,7 @@ } }, { - "description": "If `true`, only the first found geoip data will be returned, even if the field contains an array.", + "description": "If `true`, only the first found IP location data will be returned, even if the field contains an array.", "name": "first_only", "required": false, "serverDefault": true, @@ -122958,7 +122958,7 @@ } }, { - "description": "Controls what properties are added to the `target_field` based on the geoip lookup.", + "description": "Controls what properties are added to the `target_field` based on the IP location lookup.", "name": "properties", "required": false, "type": { @@ -122998,7 +122998,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L442-L476" + "specLocation": "ingest/_types/Processors.ts#L478-L512" }, { "inherits": { @@ -123127,6 +123127,113 @@ ], "specLocation": "ingest/_types/Processors.ts#L388-L429" }, + { + "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" + } + } + }, + { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "name": "download_database_on_pipeline_creation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L442-L476" + }, { "inherits": { "type": { @@ -123230,7 +123337,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L914-L945" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "inherits": { @@ -123308,7 +123415,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L947-L971" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "inherits": { @@ -123362,7 +123469,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L973-L989" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "inherits": { @@ -123434,7 +123541,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L991-L1010" + "specLocation": "ingest/_types/Processors.ts#L1027-L1046" }, { "kind": "interface", @@ -123468,7 +123575,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1012-L1024", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -123507,7 +123614,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1026-L1037" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -123581,7 +123688,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1039-L1065" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "inherits": { @@ -123634,7 +123741,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1067-L1082" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "inherits": { @@ -123713,7 +123820,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1084-L1113" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "inherits": { @@ -123870,7 +123977,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1122-L1174" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "inherits": { @@ -123924,7 +124031,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1176-L1192" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "inherits": { @@ -124019,7 +124126,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1194-L1228" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "inherits": { @@ -124060,7 +124167,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1230-L1241" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "inherits": { @@ -124196,7 +124303,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1243-L1284" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "inherits": { @@ -124249,7 +124356,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1286-L1302" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "inherits": { @@ -124302,7 +124409,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1304-L1318" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "inherits": { @@ -124355,7 +124462,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1320-L1336" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "inherits": { @@ -124437,7 +124544,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1338-L1366" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "inherits": { @@ -124509,7 +124616,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1368-L1388" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "inherits": { @@ -124595,7 +124702,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1390-L1424" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "inherits": { @@ -124638,7 +124745,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1426-L1435" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "inherits": { @@ -124691,7 +124798,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1442-L1458" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "inherits": { @@ -124770,7 +124877,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1460-L1485" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "inherits": { @@ -124785,7 +124892,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1487-L1487" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "inherits": { @@ -124839,7 +124946,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1489-L1505" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "inherits": { @@ -124893,7 +125000,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1507-L1523" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "inherits": { @@ -124947,7 +125054,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1525-L1541" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "inherits": { @@ -125027,7 +125134,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1543-L1569" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "inherits": { @@ -125140,7 +125247,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L478-L509" + "specLocation": "ingest/_types/Processors.ts#L514-L545" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 57a215463f..d101a287fd 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -141519,7 +141519,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L519-L535" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "kind": "interface", @@ -141596,7 +141596,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L537-L560" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "kind": "interface", @@ -141755,7 +141755,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L562-L623" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "kind": "interface", @@ -141821,7 +141821,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L636-L656" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "kind": "enum", @@ -141855,7 +141855,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L625-L634" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "interface", @@ -141953,7 +141953,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L658-L691" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "kind": "interface", @@ -142093,7 +142093,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L693-L731" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "kind": "interface", @@ -142188,7 +142188,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L733-L766" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "kind": "interface", @@ -142254,7 +142254,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L768-L787" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "kind": "interface", @@ -142307,7 +142307,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L789-L807" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "kind": "interface", @@ -142322,7 +142322,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L809-L809" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "kind": "interface", @@ -142426,7 +142426,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L811-L850" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "kind": "interface", @@ -142454,7 +142454,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L852-L858" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "kind": "enum", @@ -142484,7 +142484,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L860-L866" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "interface", @@ -142563,7 +142563,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L868-L896" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "kind": "interface", @@ -142616,7 +142616,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L898-L912" + "specLocation": "ingest/_types/Processors.ts#L934-L948" }, { "kind": "interface", @@ -142990,7 +142990,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L914-L945" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "kind": "interface", @@ -143068,7 +143068,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L947-L971" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "kind": "interface", @@ -143122,7 +143122,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L973-L989" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "kind": "interface", @@ -143156,7 +143156,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1012-L1024", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -143233,7 +143233,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1039-L1065" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "kind": "interface", @@ -143269,7 +143269,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1026-L1037" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -143341,7 +143341,114 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L991-L1010" + "specLocation": "ingest/_types/Processors.ts#L1027-L1046" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "IpLocationProcessor", + "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 IP location 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 IP location 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" + } + } + }, + { + "description": "If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created.\nElse, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.", + "name": "download_database_on_pipeline_creation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L478-L512" }, { "kind": "interface", @@ -143394,7 +143501,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1067-L1082" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "kind": "interface", @@ -143473,7 +143580,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1084-L1113" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "kind": "enum", @@ -143491,7 +143598,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1115-L1120" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "interface", @@ -143648,7 +143755,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1122-L1174" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "kind": "interface", @@ -143702,7 +143809,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1176-L1192" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "kind": "interface", @@ -143818,7 +143925,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1194-L1228" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "kind": "interface", @@ -143997,7 +144104,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1230-L1241" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "kind": "interface", @@ -144310,7 +144417,7 @@ "type": { "kind": "instance_of", "type": { - "name": "GeoIpProcessor", + "name": "IpLocationProcessor", "namespace": "ingest._types" } } @@ -144846,7 +144953,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1243-L1284" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "kind": "interface", @@ -144899,7 +145006,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1286-L1302" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "kind": "interface", @@ -144952,7 +145059,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1304-L1318" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "kind": "interface", @@ -145005,7 +145112,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1320-L1336" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "kind": "interface", @@ -145087,7 +145194,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1338-L1366" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "kind": "interface", @@ -145159,7 +145266,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1368-L1388" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "kind": "interface", @@ -145245,7 +145352,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1390-L1424" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "kind": "interface", @@ -145288,7 +145395,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1426-L1435" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "kind": "enum", @@ -145304,7 +145411,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1437-L1440" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "interface", @@ -145357,7 +145464,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1442-L1458" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "kind": "interface", @@ -145436,7 +145543,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1460-L1485" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "kind": "interface", @@ -145451,7 +145558,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1487-L1487" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "kind": "interface", @@ -145505,7 +145612,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1489-L1505" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "kind": "interface", @@ -145559,7 +145666,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1507-L1523" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "kind": "interface", @@ -145639,7 +145746,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1543-L1569" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "kind": "interface", @@ -145693,7 +145800,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1525-L1541" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "kind": "interface", @@ -145806,7 +145913,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L478-L509" + "specLocation": "ingest/_types/Processors.ts#L514-L545" }, { "kind": "enum", @@ -145831,7 +145938,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L511-L517" + "specLocation": "ingest/_types/Processors.ts#L547-L553" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index e626209a8a..b575b2e54e 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12993,6 +12993,16 @@ export interface IngestInferenceProcessor extends IngestProcessorBase { inference_config?: IngestInferenceConfig } +export interface IngestIpLocationProcessor extends IngestProcessorBase { + database_file?: string + field: Field + first_only?: boolean + ignore_missing?: boolean + properties?: string[] + target_field?: Field + download_database_on_pipeline_creation?: boolean +} + export interface IngestJoinProcessor extends IngestProcessorBase { field: Field separator: string @@ -13087,7 +13097,7 @@ export interface IngestProcessorContainer { fail?: IngestFailProcessor fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor - ip_location?: IngestGeoIpProcessor + ip_location?: IngestIpLocationProcessor geo_grid?: IngestGeoGridProcessor geoip?: IngestGeoIpProcessor grok?: IngestGrokProcessor diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index c1a5f54f78..b507d6deec 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -127,7 +127,7 @@ export class ProcessorContainer { /** * Currently an undocumented alias for GeoIP Processor. */ - ip_location?: GeoIpProcessor + ip_location?: IpLocationProcessor /** * Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. * This is useful if there is a need to interact with the tile shapes as spatially indexable fields. @@ -475,6 +475,42 @@ export class GeoIpProcessor extends ProcessorBase { download_database_on_pipeline_creation?: boolean } +export class IpLocationProcessor extends ProcessorBase { + /** + * The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + * @server_default GeoLite2-City.mmdb + */ + database_file?: string + /** + * The field to get the ip address from for the geographical lookup. + */ + field: Field + /** + * If `true`, only the first found IP location data will be returned, even if the field contains an array. + * @server_default true + */ + first_only?: boolean + /** + * If `true` and `field` does not exist, the processor quietly exits without modifying the document. + * @server_default false + */ + ignore_missing?: boolean + /** + * Controls what properties are added to the `target_field` based on the IP location lookup. + */ + properties?: string[] + /** + * The field that will hold the geographical information looked up from the MaxMind database. + * @server_default geoip + */ + target_field?: Field + /** + * If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. + * Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index. + */ + download_database_on_pipeline_creation?: boolean +} + export class UserAgentProcessor extends ProcessorBase { /** * The field containing the user agent string.