diff --git a/output/schema/schema.json b/output/schema/schema.json index 0e8ec1412f..b68d51d21a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -128418,7 +128418,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L273-L288" + "specLocation": "ingest/_types/Processors.ts#L280-L295" }, { "inherits": { @@ -128525,7 +128525,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L290-L326" + "specLocation": "ingest/_types/Processors.ts#L297-L333" }, { "inherits": { @@ -128579,7 +128579,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L381-L397" + "specLocation": "ingest/_types/Processors.ts#L388-L404" }, { "inherits": { @@ -128656,7 +128656,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L399-L422" + "specLocation": "ingest/_types/Processors.ts#L406-L429" }, { "inherits": { @@ -128722,7 +128722,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L434-L454" + "specLocation": "ingest/_types/Processors.ts#L441-L461" }, { "kind": "enum", @@ -128753,7 +128753,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L424-L432" + "specLocation": "ingest/_types/Processors.ts#L431-L439" }, { "inherits": { @@ -128851,7 +128851,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L456-L489" + "specLocation": "ingest/_types/Processors.ts#L463-L496" }, { "inherits": { @@ -128957,7 +128957,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L491-L529" + "specLocation": "ingest/_types/Processors.ts#L498-L536" }, { "inherits": { @@ -129039,7 +129039,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L531-L558" + "specLocation": "ingest/_types/Processors.ts#L538-L565" }, { "inherits": { @@ -129105,7 +129105,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L560-L579" + "specLocation": "ingest/_types/Processors.ts#L567-L586" }, { "inherits": { @@ -129145,7 +129145,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L581-L592" + "specLocation": "ingest/_types/Processors.ts#L588-L599" }, { "inherits": { @@ -129160,7 +129160,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L594-L594" + "specLocation": "ingest/_types/Processors.ts#L601-L601" }, { "inherits": { @@ -129264,7 +129264,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L596-L635" + "specLocation": "ingest/_types/Processors.ts#L603-L642" }, { "inherits": { @@ -129292,7 +129292,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L637-L643" + "specLocation": "ingest/_types/Processors.ts#L644-L650" }, { "inherits": { @@ -129345,7 +129345,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L645-L659" + "specLocation": "ingest/_types/Processors.ts#L652-L666" }, { "inherits": { @@ -129440,7 +129440,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L328-L357" + "specLocation": "ingest/_types/Processors.ts#L335-L364" }, { "inherits": { @@ -129532,7 +129532,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L661-L686" + "specLocation": "ingest/_types/Processors.ts#L668-L693" }, { "inherits": { @@ -129610,7 +129610,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L688-L712" + "specLocation": "ingest/_types/Processors.ts#L695-L719" }, { "kind": "interface", @@ -129644,7 +129644,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L735-L747", + "specLocation": "ingest/_types/Processors.ts#L742-L754", "variants": { "kind": "container" } @@ -129721,7 +129721,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L762-L788" + "specLocation": "ingest/_types/Processors.ts#L769-L795" }, { "kind": "interface", @@ -129757,7 +129757,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L749-L760" + "specLocation": "ingest/_types/Processors.ts#L756-L767" }, { "inherits": { @@ -129829,7 +129829,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L714-L733" + "specLocation": "ingest/_types/Processors.ts#L721-L740" }, { "inherits": { @@ -129882,7 +129882,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L790-L805" + "specLocation": "ingest/_types/Processors.ts#L797-L812" }, { "inherits": { @@ -129961,7 +129961,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L807-L836" + "specLocation": "ingest/_types/Processors.ts#L814-L843" }, { "kind": "enum", @@ -129979,7 +129979,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L838-L843" + "specLocation": "ingest/_types/Processors.ts#L845-L850" }, { "inherits": { @@ -130136,7 +130136,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L845-L897" + "specLocation": "ingest/_types/Processors.ts#L852-L904" }, { "inherits": { @@ -130190,7 +130190,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L899-L915" + "specLocation": "ingest/_types/Processors.ts#L906-L922" }, { "kind": "interface", @@ -130356,7 +130356,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L917-L928" + "specLocation": "ingest/_types/Processors.ts#L924-L935" }, { "kind": "interface", @@ -130429,7 +130429,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L235-L258" + "specLocation": "ingest/_types/Processors.ts#L242-L265" }, { "kind": "interface", @@ -130718,6 +130718,19 @@ } } }, + { + "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", + "docId": "reroute-processor", + "name": "reroute", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RerouteProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", "docId": "script-processor", @@ -130915,7 +130928,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L28-L233", + "specLocation": "ingest/_types/Processors.ts#L28-L240", "variants": { "kind": "container", "nonExhaustive": true @@ -130960,7 +130973,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L930-L940" + "specLocation": "ingest/_types/Processors.ts#L937-L947" }, { "inherits": { @@ -131013,7 +131026,89 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L942-L958" + "specLocation": "ingest/_types/Processors.ts#L949-L965" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "RerouteProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "A static value for the target. Can’t be set when the dataset or namespace option is set.", + "name": "destination", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Field references or a static value for the dataset part of the data stream name. \nIn addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. \nExample values are nginx.access and nginx.error.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). \nWhen resolving field references, the processor replaces invalid characters with _. Uses the part \nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.dataset}}", + "name": "dataset", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Field references or a static value for the namespace part of the data stream name. See the criteria for\nindex names for allowed characters. Must be no longer than 100 characters.\n\nSupports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). \nWhen resolving field references, the processor replaces invalid characters with _. Uses the part \nof the index name as a fallback if all field references resolve to a null, missing, or non-string value.\n\ndefault {{data_stream.namespace}}", + "name": "namespace", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L967-L995" }, { "inherits": { @@ -131099,7 +131194,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L982-L1016" + "specLocation": "ingest/_types/Processors.ts#L1019-L1053" }, { "inherits": { @@ -131142,7 +131237,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1018-L1027" + "specLocation": "ingest/_types/Processors.ts#L1055-L1064" }, { "kind": "enum", @@ -131158,7 +131253,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1029-L1032" + "specLocation": "ingest/_types/Processors.ts#L1066-L1069" }, { "inherits": { @@ -131211,7 +131306,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1034-L1050" + "specLocation": "ingest/_types/Processors.ts#L1071-L1087" }, { "inherits": { @@ -131290,7 +131385,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1052-L1077" + "specLocation": "ingest/_types/Processors.ts#L1089-L1114" }, { "inherits": { @@ -131344,7 +131439,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1079-L1095" + "specLocation": "ingest/_types/Processors.ts#L1116-L1132" }, { "inherits": { @@ -131398,7 +131493,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1097-L1113" + "specLocation": "ingest/_types/Processors.ts#L1134-L1150" }, { "inherits": { @@ -131452,7 +131547,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1115-L1131" + "specLocation": "ingest/_types/Processors.ts#L1152-L1168" }, { "inherits": { @@ -131532,7 +131627,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L359-L379" + "specLocation": "ingest/_types/Processors.ts#L366-L386" }, { "kind": "enum", @@ -131572,7 +131667,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L260-L271" + "specLocation": "ingest/_types/Processors.ts#L267-L278" }, { "attachedBehaviors": [ diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 065c6f2008..0cf814db6c 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -11769,6 +11769,7 @@ export interface IngestProcessorContainer { lowercase?: IngestLowercaseProcessor remove?: IngestRemoveProcessor rename?: IngestRenameProcessor + reroute?: IngestRerouteProcessor script?: Script set?: IngestSetProcessor sort?: IngestSortProcessor @@ -11796,6 +11797,12 @@ export interface IngestRenameProcessor extends IngestProcessorBase { target_field: Field } +export interface IngestRerouteProcessor extends IngestProcessorBase { + destination?: string + dataset?: string | string[] + namespace?: string | string[] +} + export interface IngestSetProcessor extends IngestProcessorBase { copy_from?: Field field: Field diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 2bee472789..fbfa353c2a 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -379,6 +379,7 @@ realtime,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-g regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html remove-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remove-processor.html rename-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rename-processor.html +reroute-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reroute-processor.html render-search-template-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index 1429def342..83ec6ba656 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -147,6 +147,13 @@ export class ProcessorContainer { * @doc_id rename-processor */ rename?: RenameProcessor + /** + * Routes a document to another target index or data stream. + * When setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set. + * When the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme. + * @doc_id reroute-processor + */ + reroute?: RerouteProcessor /** * Runs an inline or stored script on incoming documents. * The script runs in the `ingest` context. @@ -957,6 +964,36 @@ export class RenameProcessor extends ProcessorBase { target_field: Field } +export class RerouteProcessor extends ProcessorBase { + /** + * A static value for the target. Can’t be set when the dataset or namespace option is set. + */ + destination?: string + /** + * Field references or a static value for the dataset part of the data stream name. + * In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. + * Example values are nginx.access and nginx.error. + * + * Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + * When resolving field references, the processor replaces invalid characters with _. Uses the part + * of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + * + * default {{data_stream.dataset}} + */ + dataset?: string | string[] + /** + * Field references or a static value for the namespace part of the data stream name. See the criteria for + * index names for allowed characters. Must be no longer than 100 characters. + * + * Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). + * When resolving field references, the processor replaces invalid characters with _. Uses the part + * of the index name as a fallback if all field references resolve to a null, missing, or non-string value. + * + * default {{data_stream.namespace}} + */ + namespace?: string | string[] +} + export class ScriptProcessor extends ProcessorBase { /** * ID of a stored script.