diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 1f0393387c..82af57704b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -69747,6 +69747,9 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, + "ip_location": { + "$ref": "#/components/schemas/ingest._types:IpLocationProcessor" + }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" }, @@ -70437,6 +70440,50 @@ } ] }, + "ingest._types:IpLocationProcessor": { + "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 IP location 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 IP location 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": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index becdd98a97..854c825479 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -46034,6 +46034,9 @@ "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, + "ip_location": { + "$ref": "#/components/schemas/ingest._types:IpLocationProcessor" + }, "geo_grid": { "$ref": "#/components/schemas/ingest._types:GeoGridProcessor" }, @@ -46724,6 +46727,50 @@ } ] }, + "ingest._types:IpLocationProcessor": { + "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 IP location 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 IP location 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": [ { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 8044a99b9f..2e256796b4 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -94644,7 +94644,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "enum", @@ -94674,7 +94674,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "enum", @@ -94690,7 +94690,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -94709,7 +94709,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "enum", @@ -94727,7 +94727,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "enum", @@ -94743,7 +94743,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "enum", @@ -94768,7 +94768,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L507-L513" + "specLocation": "ingest/_types/Processors.ts#L547-L553" }, { "kind": "enum", @@ -121522,6 +121522,18 @@ } } }, + { + "description": "Currently an undocumented alias for GeoIP Processor.", + "name": "ip_location", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IpLocationProcessor", + "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", @@ -121913,7 +121925,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -121977,7 +121989,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -122050,7 +122062,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "inherits": { @@ -122170,7 +122182,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "inherits": { @@ -122224,7 +122236,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "inherits": { @@ -122301,7 +122313,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "inherits": { @@ -122460,7 +122472,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "inherits": { @@ -122526,7 +122538,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "inherits": { @@ -122624,7 +122636,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "inherits": { @@ -122719,7 +122731,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "inherits": { @@ -122825,7 +122837,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "inherits": { @@ -122891,7 +122903,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "inherits": { @@ -122944,7 +122956,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "inherits": { @@ -122959,7 +122971,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "inherits": { @@ -123063,7 +123075,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "inherits": { @@ -123091,7 +123103,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "inherits": { @@ -123170,7 +123182,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "inherits": { @@ -123223,7 +123235,114 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L908" + "specLocation": "ingest/_types/Processors.ts#L934-L948" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "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" }, { "inherits": { @@ -123350,7 +123469,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "inherits": { @@ -123457,7 +123576,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "inherits": { @@ -123562,7 +123681,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "inherits": { @@ -123640,7 +123759,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "inherits": { @@ -123694,7 +123813,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "inherits": { @@ -123766,7 +123885,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L987-L1006" + "specLocation": "ingest/_types/Processors.ts#L1027-L1046" }, { "kind": "interface", @@ -123800,7 +123919,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -123839,7 +123958,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -123913,7 +124032,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "inherits": { @@ -123966,7 +124085,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "inherits": { @@ -124045,7 +124164,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "inherits": { @@ -124202,7 +124321,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "inherits": { @@ -124256,7 +124375,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "inherits": { @@ -124351,7 +124470,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "inherits": { @@ -124392,7 +124511,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "inherits": { @@ -124528,7 +124647,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "inherits": { @@ -124581,7 +124700,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "inherits": { @@ -124634,7 +124753,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "inherits": { @@ -124687,7 +124806,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "inherits": { @@ -124769,7 +124888,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "inherits": { @@ -124841,7 +124960,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "inherits": { @@ -124927,7 +125046,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "inherits": { @@ -124970,7 +125089,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "inherits": { @@ -125023,7 +125142,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "inherits": { @@ -125102,7 +125221,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "inherits": { @@ -125117,7 +125236,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "inherits": { @@ -125171,7 +125290,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "inherits": { @@ -125225,7 +125344,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "inherits": { @@ -125279,7 +125398,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "inherits": { @@ -125359,7 +125478,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "inherits": { @@ -125472,7 +125591,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L474-L505" + "specLocation": "ingest/_types/Processors.ts#L514-L545" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 17aa1e7db4..2bdc35d88d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -141176,7 +141176,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -141296,7 +141296,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "kind": "interface", @@ -141350,7 +141350,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "kind": "interface", @@ -141427,7 +141427,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "kind": "interface", @@ -141586,7 +141586,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "kind": "interface", @@ -141652,7 +141652,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "kind": "enum", @@ -141686,7 +141686,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "interface", @@ -141784,7 +141784,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "kind": "interface", @@ -141924,7 +141924,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "kind": "interface", @@ -142019,7 +142019,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "kind": "interface", @@ -142085,7 +142085,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "kind": "interface", @@ -142138,7 +142138,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "kind": "interface", @@ -142153,7 +142153,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "kind": "interface", @@ -142257,7 +142257,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "kind": "interface", @@ -142285,7 +142285,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "kind": "enum", @@ -142315,7 +142315,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "interface", @@ -142394,7 +142394,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "kind": "interface", @@ -142447,7 +142447,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L908" + "specLocation": "ingest/_types/Processors.ts#L934-L948" }, { "kind": "interface", @@ -142574,7 +142574,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "kind": "enum", @@ -142590,7 +142590,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -142609,7 +142609,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "interface", @@ -142716,7 +142716,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "kind": "interface", @@ -142821,7 +142821,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "kind": "interface", @@ -142899,7 +142899,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "kind": "interface", @@ -142953,7 +142953,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "kind": "interface", @@ -142987,7 +142987,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -143064,7 +143064,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "kind": "interface", @@ -143100,7 +143100,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -143172,7 +143172,114 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L987-L1006" + "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", @@ -143225,7 +143332,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "kind": "interface", @@ -143304,7 +143411,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "kind": "enum", @@ -143322,7 +143429,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "interface", @@ -143479,7 +143586,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "kind": "interface", @@ -143533,7 +143640,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "kind": "interface", @@ -143649,7 +143756,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "kind": "interface", @@ -143828,7 +143935,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "kind": "interface", @@ -143901,7 +144008,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "kind": "interface", @@ -144134,6 +144241,18 @@ } } }, + { + "description": "Currently an undocumented alias for GeoIP Processor.", + "name": "ip_location", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IpLocationProcessor", + "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", @@ -144525,7 +144644,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -144665,7 +144784,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "kind": "interface", @@ -144718,7 +144837,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "kind": "interface", @@ -144771,7 +144890,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "kind": "interface", @@ -144824,7 +144943,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "kind": "interface", @@ -144906,7 +145025,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "kind": "interface", @@ -144978,7 +145097,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "kind": "interface", @@ -145064,7 +145183,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "kind": "interface", @@ -145107,7 +145226,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "kind": "enum", @@ -145123,7 +145242,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "interface", @@ -145176,7 +145295,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "kind": "interface", @@ -145255,7 +145374,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "kind": "interface", @@ -145270,7 +145389,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "kind": "interface", @@ -145324,7 +145443,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "kind": "interface", @@ -145378,7 +145497,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "kind": "interface", @@ -145458,7 +145577,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "kind": "interface", @@ -145512,7 +145631,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "kind": "interface", @@ -145625,7 +145744,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L474-L505" + "specLocation": "ingest/_types/Processors.ts#L514-L545" }, { "kind": "enum", @@ -145650,7 +145769,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L507-L513" + "specLocation": "ingest/_types/Processors.ts#L547-L553" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 284394a2d6..680b3e10c5 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12981,6 +12981,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 @@ -13075,6 +13085,7 @@ export interface IngestProcessorContainer { fail?: IngestFailProcessor fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor + 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 33402841a9..b507d6deec 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?: 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. @@ -471,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.