diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 0c82f033d2..b91f8a1db2 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 9bdef094ce..06beb944dc 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 aaa68fe1b8..2eaf289aea 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -94640,7 +94640,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "enum", @@ -94670,7 +94670,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "enum", @@ -94686,7 +94686,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -94705,7 +94705,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "enum", @@ -94723,7 +94723,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "enum", @@ -94739,7 +94739,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "enum", @@ -94764,7 +94764,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L507-L513" + "specLocation": "ingest/_types/Processors.ts#L547-L553" }, { "kind": "enum", @@ -121518,6 +121518,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", @@ -121909,7 +121921,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -121973,7 +121985,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -122046,7 +122058,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "inherits": { @@ -122166,7 +122178,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "inherits": { @@ -122220,7 +122232,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "inherits": { @@ -122297,7 +122309,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "inherits": { @@ -122456,7 +122468,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "inherits": { @@ -122522,7 +122534,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "inherits": { @@ -122620,7 +122632,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "inherits": { @@ -122715,7 +122727,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "inherits": { @@ -122821,7 +122833,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "inherits": { @@ -122887,7 +122899,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "inherits": { @@ -122940,7 +122952,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "inherits": { @@ -122955,7 +122967,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "inherits": { @@ -123059,7 +123071,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "inherits": { @@ -123087,7 +123099,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "inherits": { @@ -123166,7 +123178,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "inherits": { @@ -123219,7 +123231,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": { @@ -123346,7 +123465,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "inherits": { @@ -123453,7 +123572,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "inherits": { @@ -123558,7 +123677,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "inherits": { @@ -123636,7 +123755,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "inherits": { @@ -123690,7 +123809,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "inherits": { @@ -123762,7 +123881,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L987-L1006" + "specLocation": "ingest/_types/Processors.ts#L1027-L1046" }, { "kind": "interface", @@ -123796,7 +123915,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -123835,7 +123954,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -123909,7 +124028,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "inherits": { @@ -123962,7 +124081,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "inherits": { @@ -124041,7 +124160,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "inherits": { @@ -124198,7 +124317,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "inherits": { @@ -124252,7 +124371,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "inherits": { @@ -124347,7 +124466,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "inherits": { @@ -124388,7 +124507,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "inherits": { @@ -124524,7 +124643,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "inherits": { @@ -124577,7 +124696,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "inherits": { @@ -124630,7 +124749,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "inherits": { @@ -124683,7 +124802,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "inherits": { @@ -124765,7 +124884,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "inherits": { @@ -124837,7 +124956,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "inherits": { @@ -124923,7 +125042,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "inherits": { @@ -124966,7 +125085,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "inherits": { @@ -125019,7 +125138,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "inherits": { @@ -125098,7 +125217,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "inherits": { @@ -125113,7 +125232,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "inherits": { @@ -125167,7 +125286,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "inherits": { @@ -125221,7 +125340,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "inherits": { @@ -125275,7 +125394,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "inherits": { @@ -125355,7 +125474,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "inherits": { @@ -125468,7 +125587,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 3f454a59b3..08deb6b492 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -141251,7 +141251,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L324-L339" + "specLocation": "ingest/_types/Processors.ts#L328-L343" }, { "kind": "interface", @@ -141371,7 +141371,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L341-L382" + "specLocation": "ingest/_types/Processors.ts#L345-L386" }, { "kind": "interface", @@ -141425,7 +141425,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L515-L531" + "specLocation": "ingest/_types/Processors.ts#L555-L571" }, { "kind": "interface", @@ -141502,7 +141502,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L533-L556" + "specLocation": "ingest/_types/Processors.ts#L573-L596" }, { "kind": "interface", @@ -141661,7 +141661,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L558-L619" + "specLocation": "ingest/_types/Processors.ts#L598-L659" }, { "kind": "interface", @@ -141727,7 +141727,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L632-L652" + "specLocation": "ingest/_types/Processors.ts#L672-L692" }, { "kind": "enum", @@ -141761,7 +141761,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L621-L630" + "specLocation": "ingest/_types/Processors.ts#L661-L670" }, { "kind": "interface", @@ -141859,7 +141859,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L654-L687" + "specLocation": "ingest/_types/Processors.ts#L694-L727" }, { "kind": "interface", @@ -141999,7 +141999,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L689-L727" + "specLocation": "ingest/_types/Processors.ts#L729-L767" }, { "kind": "interface", @@ -142094,7 +142094,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L762" + "specLocation": "ingest/_types/Processors.ts#L769-L802" }, { "kind": "interface", @@ -142160,7 +142160,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L764-L783" + "specLocation": "ingest/_types/Processors.ts#L804-L823" }, { "kind": "interface", @@ -142213,7 +142213,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L785-L803" + "specLocation": "ingest/_types/Processors.ts#L825-L843" }, { "kind": "interface", @@ -142228,7 +142228,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L805-L805" + "specLocation": "ingest/_types/Processors.ts#L845-L845" }, { "kind": "interface", @@ -142332,7 +142332,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L846" + "specLocation": "ingest/_types/Processors.ts#L847-L886" }, { "kind": "interface", @@ -142360,7 +142360,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L848-L854" + "specLocation": "ingest/_types/Processors.ts#L888-L894" }, { "kind": "enum", @@ -142390,7 +142390,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L856-L862" + "specLocation": "ingest/_types/Processors.ts#L896-L902" }, { "kind": "interface", @@ -142469,7 +142469,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L864-L892" + "specLocation": "ingest/_types/Processors.ts#L904-L932" }, { "kind": "interface", @@ -142522,7 +142522,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L908" + "specLocation": "ingest/_types/Processors.ts#L934-L948" }, { "kind": "interface", @@ -142649,7 +142649,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L384-L425" + "specLocation": "ingest/_types/Processors.ts#L388-L429" }, { "kind": "enum", @@ -142665,7 +142665,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L433-L436" + "specLocation": "ingest/_types/Processors.ts#L437-L440" }, { "kind": "enum", @@ -142684,7 +142684,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L427-L431" + "specLocation": "ingest/_types/Processors.ts#L431-L435" }, { "kind": "interface", @@ -142791,7 +142791,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L438-L472" + "specLocation": "ingest/_types/Processors.ts#L442-L476" }, { "kind": "interface", @@ -142896,7 +142896,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L910-L941" + "specLocation": "ingest/_types/Processors.ts#L950-L981" }, { "kind": "interface", @@ -142974,7 +142974,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L943-L967" + "specLocation": "ingest/_types/Processors.ts#L983-L1007" }, { "kind": "interface", @@ -143028,7 +143028,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L969-L985" + "specLocation": "ingest/_types/Processors.ts#L1009-L1025" }, { "kind": "interface", @@ -143062,7 +143062,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1008-L1020", + "specLocation": "ingest/_types/Processors.ts#L1048-L1060", "variants": { "kind": "container" } @@ -143139,7 +143139,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1035-L1061" + "specLocation": "ingest/_types/Processors.ts#L1075-L1101" }, { "kind": "interface", @@ -143175,7 +143175,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1022-L1033" + "specLocation": "ingest/_types/Processors.ts#L1062-L1073" }, { "kind": "interface", @@ -143247,7 +143247,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", @@ -143300,7 +143407,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1063-L1078" + "specLocation": "ingest/_types/Processors.ts#L1103-L1118" }, { "kind": "interface", @@ -143379,7 +143486,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1080-L1109" + "specLocation": "ingest/_types/Processors.ts#L1120-L1149" }, { "kind": "enum", @@ -143397,7 +143504,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1111-L1116" + "specLocation": "ingest/_types/Processors.ts#L1151-L1156" }, { "kind": "interface", @@ -143554,7 +143661,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1118-L1170" + "specLocation": "ingest/_types/Processors.ts#L1158-L1210" }, { "kind": "interface", @@ -143608,7 +143715,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + "specLocation": "ingest/_types/Processors.ts#L1212-L1228" }, { "kind": "interface", @@ -143724,7 +143831,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + "specLocation": "ingest/_types/Processors.ts#L1230-L1264" }, { "kind": "interface", @@ -143903,7 +144010,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + "specLocation": "ingest/_types/Processors.ts#L1266-L1277" }, { "kind": "interface", @@ -143976,7 +144083,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L299-L322" + "specLocation": "ingest/_types/Processors.ts#L303-L326" }, { "kind": "interface", @@ -144209,6 +144316,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", @@ -144600,7 +144719,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L297", + "specLocation": "ingest/_types/Processors.ts#L27-L301", "variants": { "kind": "container", "nonExhaustive": true @@ -144740,7 +144859,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + "specLocation": "ingest/_types/Processors.ts#L1279-L1320" }, { "kind": "interface", @@ -144793,7 +144912,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1282-L1298" + "specLocation": "ingest/_types/Processors.ts#L1322-L1338" }, { "kind": "interface", @@ -144846,7 +144965,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1300-L1314" + "specLocation": "ingest/_types/Processors.ts#L1340-L1354" }, { "kind": "interface", @@ -144899,7 +145018,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1316-L1332" + "specLocation": "ingest/_types/Processors.ts#L1356-L1372" }, { "kind": "interface", @@ -144981,7 +145100,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1334-L1362" + "specLocation": "ingest/_types/Processors.ts#L1374-L1402" }, { "kind": "interface", @@ -145053,7 +145172,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1364-L1384" + "specLocation": "ingest/_types/Processors.ts#L1404-L1424" }, { "kind": "interface", @@ -145139,7 +145258,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1386-L1420" + "specLocation": "ingest/_types/Processors.ts#L1426-L1460" }, { "kind": "interface", @@ -145182,7 +145301,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1422-L1431" + "specLocation": "ingest/_types/Processors.ts#L1462-L1471" }, { "kind": "enum", @@ -145198,7 +145317,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1433-L1436" + "specLocation": "ingest/_types/Processors.ts#L1473-L1476" }, { "kind": "interface", @@ -145251,7 +145370,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1438-L1454" + "specLocation": "ingest/_types/Processors.ts#L1478-L1494" }, { "kind": "interface", @@ -145330,7 +145449,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1456-L1481" + "specLocation": "ingest/_types/Processors.ts#L1496-L1521" }, { "kind": "interface", @@ -145345,7 +145464,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1483-L1483" + "specLocation": "ingest/_types/Processors.ts#L1523-L1523" }, { "kind": "interface", @@ -145399,7 +145518,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1485-L1501" + "specLocation": "ingest/_types/Processors.ts#L1525-L1541" }, { "kind": "interface", @@ -145453,7 +145572,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1503-L1519" + "specLocation": "ingest/_types/Processors.ts#L1543-L1559" }, { "kind": "interface", @@ -145533,7 +145652,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1539-L1565" + "specLocation": "ingest/_types/Processors.ts#L1579-L1605" }, { "kind": "interface", @@ -145587,7 +145706,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1521-L1537" + "specLocation": "ingest/_types/Processors.ts#L1561-L1577" }, { "kind": "interface", @@ -145700,7 +145819,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L474-L505" + "specLocation": "ingest/_types/Processors.ts#L514-L545" }, { "kind": "enum", @@ -145725,7 +145844,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 f4854b275d..98746f2510 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12989,6 +12989,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 @@ -13083,6 +13093,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.