github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_streams_schema.devdocs.json

4653 lines
No EOL
169 KiB
JSON
Raw Blame History

{
"id": "@kbn/streams-schema",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.conditionToQueryDsl",
"type": "Function",
"tags": [],
"label": "conditionToQueryDsl",
"description": [],
"signature": [
"(condition: ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
") => any"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/condition_to_query_dsl.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.conditionToQueryDsl.$1",
"type": "CompoundType",
"tags": [],
"label": "condition",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/condition_to_query_dsl.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritedLifecycle",
"type": "Function",
"tags": [],
"label": "findInheritedLifecycle",
"description": [],
"signature": [
"(definition: ",
"WiredStream",
".Definition, ancestors: ",
"WiredStream",
".Definition[]) => ",
"WiredIngestStreamEffectiveLifecycle"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritedLifecycle.$1",
"type": "Object",
"tags": [],
"label": "definition",
"description": [],
"signature": [
"WiredStream",
".Definition"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritedLifecycle.$2",
"type": "Array",
"tags": [],
"label": "ancestors",
"description": [],
"signature": [
"WiredStream",
".Definition[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritingStreams",
"type": "Function",
"tags": [],
"label": "findInheritingStreams",
"description": [],
"signature": [
"(root: ",
"WiredStream",
".Definition, descendants: ",
"WiredStream",
".Definition[]) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritingStreams.$1",
"type": "Object",
"tags": [],
"label": "root",
"description": [],
"signature": [
"WiredStream",
".Definition"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.findInheritingStreams.$2",
"type": "Array",
"tags": [],
"label": "descendants",
"description": [],
"signature": [
"WiredStream",
".Definition[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/lifecycle.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAdvancedParameters",
"type": "Function",
"tags": [],
"label": "getAdvancedParameters",
"description": [],
"signature": [
"(fieldName: string, fieldConfig: (",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }) => Partial<(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_advanced_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAdvancedParameters.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_advanced_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAdvancedParameters.$2",
"type": "CompoundType",
"tags": [],
"label": "fieldConfig",
"description": [],
"signature": [
"(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_advanced_parameters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAncestors",
"type": "Function",
"tags": [],
"label": "getAncestors",
"description": [],
"signature": [
"(id: string) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAncestors.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAncestorsAndSelf",
"type": "Function",
"tags": [],
"label": "getAncestorsAndSelf",
"description": [],
"signature": [
"(id: string) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getAncestorsAndSelf.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getConditionFields",
"type": "Function",
"tags": [],
"label": "getConditionFields",
"description": [],
"signature": [
"(condition: ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
") => { name: string; type: \"string\" | \"number\"; }[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_condition_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getConditionFields.$1",
"type": "CompoundType",
"tags": [],
"label": "condition",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_condition_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getInheritedFieldsFromAncestors",
"type": "Function",
"tags": [],
"label": "getInheritedFieldsFromAncestors",
"description": [],
"signature": [
"(ancestors: ",
"WiredStream",
".Definition[]) => ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.InheritedFieldDefinition",
"text": "InheritedFieldDefinition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_inherited_fields_from_ancestors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getInheritedFieldsFromAncestors.$1",
"type": "Array",
"tags": [],
"label": "ancestors",
"description": [],
"signature": [
"WiredStream",
".Definition[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/get_inherited_fields_from_ancestors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getParentId",
"type": "Function",
"tags": [],
"label": "getParentId",
"description": [],
"signature": [
"(id: string) => string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getParentId.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getProcessorConfig",
"type": "Function",
"tags": [],
"label": "getProcessorConfig",
"description": [],
"signature": [
"(processor: TProcessorDefinition) => ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorConfig",
"text": "ProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getProcessorConfig.$1",
"type": "Uncategorized",
"tags": [],
"label": "processor",
"description": [],
"signature": [
"TProcessorDefinition"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getProcessorType",
"type": "Function",
"tags": [],
"label": "getProcessorType",
"description": [],
"signature": [
"(processor: TProcessorDefinition) => ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorTypeOf",
"text": "ProcessorTypeOf"
},
"<TProcessorDefinition>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getProcessorType.$1",
"type": "Uncategorized",
"tags": [],
"label": "processor",
"description": [],
"signature": [
"TProcessorDefinition"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getRegularEcsField",
"type": "Function",
"tags": [],
"label": "getRegularEcsField",
"description": [],
"signature": [
"(field: string) => string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getRegularEcsField.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getSegments",
"type": "Function",
"tags": [],
"label": "getSegments",
"description": [],
"signature": [
"(id: string) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.getSegments.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isAlwaysCondition",
"type": "Function",
"tags": [],
"label": "isAlwaysCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, { always: {}; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isAlwaysCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isAndCondition",
"type": "Function",
"tags": [],
"label": "isAndCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, { and: ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
"[]; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isAndCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isBinaryFilterCondition",
"type": "Function",
"tags": [],
"label": "isBinaryFilterCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.BinaryFilterCondition",
"text": "BinaryFilterCondition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isBinaryFilterCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isChildOf",
"type": "Function",
"tags": [],
"label": "isChildOf",
"description": [],
"signature": [
"(parent: string, child: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isChildOf.$1",
"type": "string",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isChildOf.$2",
"type": "string",
"tags": [],
"label": "child",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isCondition",
"type": "Function",
"tags": [],
"label": "isCondition",
"description": [],
"signature": [
"<TValue extends unknown>(value: TValue) => value is Extract<TValue, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDescendantOf",
"type": "Function",
"tags": [],
"label": "isDescendantOf",
"description": [],
"signature": [
"(parent: string, child: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDescendantOf.$1",
"type": "string",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDescendantOf.$2",
"type": "string",
"tags": [],
"label": "child",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDisabledLifecycle",
"type": "Function",
"tags": [],
"label": "isDisabledLifecycle",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamEffectiveLifecycle",
"text": "IngestStreamEffectiveLifecycle"
},
">(value: TValue) => value is Extract<TValue, { disabled: {}; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDisabledLifecycle.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDslLifecycle",
"type": "Function",
"tags": [],
"label": "isDslLifecycle",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamEffectiveLifecycle",
"text": "IngestStreamEffectiveLifecycle"
},
">(value: TValue) => value is Extract<TValue, { dsl: { data_retention?: string | undefined; }; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isDslLifecycle.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isErrorLifecycle",
"type": "Function",
"tags": [],
"label": "isErrorLifecycle",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnwiredIngestStreamEffectiveLifecycle",
"text": "UnwiredIngestStreamEffectiveLifecycle"
},
">(value: TValue) => value is Extract<TValue, { error: { message: string; }; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isErrorLifecycle.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isFilterCondition",
"type": "Function",
"tags": [],
"label": "isFilterCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.BinaryFilterCondition",
"text": "BinaryFilterCondition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnaryFilterCondition",
"text": "UnaryFilterCondition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isFilterCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isIlmLifecycle",
"type": "Function",
"tags": [],
"label": "isIlmLifecycle",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamEffectiveLifecycle",
"text": "IngestStreamEffectiveLifecycle"
},
">(value: TValue) => value is Extract<TValue, { ilm: { policy: string; }; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isIlmLifecycle.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isInheritLifecycle",
"type": "Function",
"tags": [],
"label": "isInheritLifecycle",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamEffectiveLifecycle",
"text": "IngestStreamEffectiveLifecycle"
},
">(value: TValue) => value is Extract<TValue, { inherit: {}; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isInheritLifecycle.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isNamespacedEcsField",
"type": "Function",
"tags": [],
"label": "isNamespacedEcsField",
"description": [],
"signature": [
"(field: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isNamespacedEcsField.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isNeverCondition",
"type": "Function",
"tags": [],
"label": "isNeverCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, { never: {}; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isNeverCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isOrCondition",
"type": "Function",
"tags": [],
"label": "isOrCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, { or: ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
"[]; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isOrCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isRoot",
"type": "Function",
"tags": [],
"label": "isRoot",
"description": [],
"signature": [
"(id: string) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isRoot.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/hierarchy.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isRootStreamDefinition",
"type": "Function",
"tags": [],
"label": "isRootStreamDefinition",
"description": [],
"signature": [
"<TValue extends ",
"WiredStream",
".Definition | ",
"UnwiredStream",
".Definition | ",
"GroupStream",
".Definition>(value: TValue) => value is Extract<TValue, ",
"WiredStream",
".Definition>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/is_root.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isRootStreamDefinition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isSchema",
"type": "Function",
"tags": [],
"label": "isSchema",
"description": [],
"signature": [
"(schema: TSchema, value: unknown) => boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isSchema.$1",
"type": "Uncategorized",
"tags": [],
"label": "schema",
"description": [],
"signature": [
"TSchema"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isSchema.$2",
"type": "Unknown",
"tags": [],
"label": "value",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isUnaryFilterCondition",
"type": "Function",
"tags": [],
"label": "isUnaryFilterCondition",
"description": [],
"signature": [
"<TValue extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">(value: TValue) => value is Extract<TValue, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnaryFilterCondition",
"text": "UnaryFilterCondition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.isUnaryFilterCondition.$1",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"TValue"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/type_guards.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.AlwaysCondition",
"type": "Interface",
"tags": [],
"label": "AlwaysCondition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.AlwaysCondition.always",
"type": "Object",
"tags": [],
"label": "always",
"description": [],
"signature": [
"{}"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.BinaryFilterCondition",
"type": "Interface",
"tags": [],
"label": "BinaryFilterCondition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.BinaryFilterCondition.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.BinaryFilterCondition.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"\"endsWith\" | \"startsWith\" | \"gte\" | \"lte\" | \"gt\" | \"lt\" | \"eq\" | \"contains\" | \"neq\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.BinaryFilterCondition.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | number | boolean"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ContentPack",
"type": "Interface",
"tags": [],
"label": "ContentPack",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/content/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ContentPack.content",
"type": "string",
"tags": [],
"label": "content",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/content/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig",
"type": "Interface",
"tags": [],
"label": "DateProcessorConfig",
"description": [
"\nDate processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DateProcessorConfig",
"text": "DateProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.formats",
"type": "Array",
"tags": [],
"label": "formats",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.locale",
"type": "string",
"tags": [],
"label": "locale",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.timezone",
"type": "string",
"tags": [],
"label": "timezone",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorConfig.output_format",
"type": "string",
"tags": [],
"label": "output_format",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "DateProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DateProcessorDefinition.date",
"type": "Object",
"tags": [],
"label": "date",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DateProcessorConfig",
"text": "DateProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorConfig",
"type": "Interface",
"tags": [],
"label": "DissectProcessorConfig",
"description": [
"\nDissect processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DissectProcessorConfig",
"text": "DissectProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorConfig.pattern",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorConfig.append_separator",
"type": "string",
"tags": [],
"label": "append_separator",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "DissectProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.DissectProcessorDefinition.dissect",
"type": "Object",
"tags": [],
"label": "dissect",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DissectProcessorConfig",
"text": "DissectProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FieldDefinition",
"type": "Interface",
"tags": [],
"label": "FieldDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FieldDefinition.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[x: string]: (MappingBooleanProperty & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (MappingKeywordProperty & { ...; }) | ... 5 more ... | { ...; }",
"description": [],
"signature": [
"[x: string]: (",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig",
"type": "Interface",
"tags": [],
"label": "GeoIpProcessorConfig",
"description": [
"\nGeoIP processor"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.database_file",
"type": "string",
"tags": [],
"label": "database_file",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.properties",
"type": "Array",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorConfig.first_only",
"type": "CompoundType",
"tags": [],
"label": "first_only",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "GeoIpProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GeoIpProcessorDefinition.geoip",
"type": "Object",
"tags": [],
"label": "geoip",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GeoIpProcessorConfig",
"text": "GeoIpProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorConfig",
"type": "Interface",
"tags": [],
"label": "GrokProcessorConfig",
"description": [
"\nGrok processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GrokProcessorConfig",
"text": "GrokProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorConfig.patterns",
"type": "Array",
"tags": [],
"label": "patterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorConfig.pattern_definitions",
"type": "Object",
"tags": [],
"label": "pattern_definitions",
"description": [],
"signature": [
"Record<string, string> | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "GrokProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.GrokProcessorDefinition.grok",
"type": "Object",
"tags": [],
"label": "grok",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GrokProcessorConfig",
"text": "GrokProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Group",
"type": "Interface",
"tags": [],
"label": "Group",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/group/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Group.members",
"type": "Array",
"tags": [],
"label": "members",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/group/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyDeletePhase",
"type": "Interface",
"tags": [],
"label": "IlmPolicyDeletePhase",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyDeletePhase.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"delete\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyDeletePhase.min_age",
"type": "string",
"tags": [],
"label": "min_age",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyHotPhase",
"type": "Interface",
"tags": [],
"label": "IlmPolicyHotPhase",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyHotPhase",
"text": "IlmPolicyHotPhase"
},
" extends ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyPhase",
"text": "IlmPolicyPhase"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyHotPhase.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"hot\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyHotPhase.rollover",
"type": "Object",
"tags": [],
"label": "rollover",
"description": [],
"signature": [
"{ max_size?: string | number | undefined; max_primary_shard_size?: string | number | undefined; max_age?: string | undefined; max_docs?: number | undefined; max_primary_shard_docs?: number | undefined; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhase",
"type": "Interface",
"tags": [],
"label": "IlmPolicyPhase",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhase.name",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"\"delete\" | \"warm\" | \"hot\" | \"frozen\" | \"cold\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhase.size_in_bytes",
"type": "number",
"tags": [],
"label": "size_in_bytes",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhase.min_age",
"type": "string",
"tags": [],
"label": "min_age",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases",
"type": "Interface",
"tags": [],
"label": "IlmPolicyPhases",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases.hot",
"type": "Object",
"tags": [],
"label": "hot",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyHotPhase",
"text": "IlmPolicyHotPhase"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases.warm",
"type": "Object",
"tags": [],
"label": "warm",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyPhase",
"text": "IlmPolicyPhase"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases.cold",
"type": "Object",
"tags": [],
"label": "cold",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyPhase",
"text": "IlmPolicyPhase"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases.frozen",
"type": "Object",
"tags": [],
"label": "frozen",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyPhase",
"text": "IlmPolicyPhase"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IlmPolicyPhases.delete",
"type": "Object",
"tags": [],
"label": "delete",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IlmPolicyDeletePhase",
"text": "IlmPolicyDeletePhase"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestBase",
"type": "Interface",
"tags": [],
"label": "IngestBase",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/base.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestBase.lifecycle",
"type": "CompoundType",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
"IngestStreamLifecycleDSL",
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamLifecycleILM",
"text": "IngestStreamLifecycleILM"
},
" | ",
"IngestStreamLifecycleInherit"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/base.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestBase.processing",
"type": "Array",
"tags": [],
"label": "processing",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinition",
"text": "ProcessorDefinition"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/base.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestStreamLifecycleILM",
"type": "Interface",
"tags": [],
"label": "IngestStreamLifecycleILM",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestStreamLifecycleILM.ilm",
"type": "Object",
"tags": [],
"label": "ilm",
"description": [],
"signature": [
"{ policy: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.InheritedFieldDefinition",
"type": "Interface",
"tags": [],
"label": "InheritedFieldDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.InheritedFieldDefinition.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[x: string]: (MappingBooleanProperty & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | ... 6 more ... | ({ ...; } & { ...; })",
"description": [],
"signature": [
"[x: string]: (",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | ({ type: \"system\"; } & { from: string; alias_for?: string | undefined; })"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig",
"type": "Interface",
"tags": [],
"label": "KvProcessorConfig",
"description": [
"\nKV processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.KvProcessorConfig",
"text": "KvProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.field_split",
"type": "string",
"tags": [],
"label": "field_split",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.value_split",
"type": "string",
"tags": [],
"label": "value_split",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.include_keys",
"type": "Array",
"tags": [],
"label": "include_keys",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.exclude_keys",
"type": "Array",
"tags": [],
"label": "exclude_keys",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.prefix",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.trim_key",
"type": "string",
"tags": [],
"label": "trim_key",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.trim_value",
"type": "string",
"tags": [],
"label": "trim_value",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorConfig.strip_brackets",
"type": "CompoundType",
"tags": [],
"label": "strip_brackets",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "KvProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.KvProcessorDefinition.kv",
"type": "Object",
"tags": [],
"label": "kv",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.KvProcessorConfig",
"text": "KvProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorConfig",
"type": "Interface",
"tags": [],
"label": "ManualIngestPipelineProcessorConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ManualIngestPipelineProcessorConfig",
"text": "ManualIngestPipelineProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorConfig.processors",
"type": "Array",
"tags": [],
"label": "processors",
"description": [],
"signature": [
"Partial<Record<keyof ",
"IngestProcessorContainer",
", unknown>>[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorConfig.ignore_failure",
"type": "CompoundType",
"tags": [],
"label": "ignore_failure",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorConfig.tag",
"type": "string",
"tags": [],
"label": "tag",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorConfig.on_failure",
"type": "Array",
"tags": [],
"label": "on_failure",
"description": [],
"signature": [
"Record<string, unknown>[] | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "ManualIngestPipelineProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ManualIngestPipelineProcessorDefinition.manual_ingest_pipeline",
"type": "Object",
"tags": [],
"label": "manual_ingest_pipeline",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ManualIngestPipelineProcessorConfig",
"text": "ManualIngestPipelineProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.NeverCondition",
"type": "Interface",
"tags": [],
"label": "NeverCondition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.NeverCondition.never",
"type": "Object",
"tags": [],
"label": "never",
"description": [],
"signature": [
"{}"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorConfig",
"type": "Interface",
"tags": [],
"label": "RenameProcessorConfig",
"description": [
"\nRename processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RenameProcessorConfig",
"text": "RenameProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorConfig.override",
"type": "CompoundType",
"tags": [],
"label": "override",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "RenameProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RenameProcessorDefinition.rename",
"type": "Object",
"tags": [],
"label": "rename",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RenameProcessorConfig",
"text": "RenameProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RoutingDefinition",
"type": "Interface",
"tags": [],
"label": "RoutingDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/routing/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RoutingDefinition.destination",
"type": "string",
"tags": [],
"label": "destination",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/routing/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.RoutingDefinition.if",
"type": "CompoundType",
"tags": [],
"label": "if",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.FilterCondition",
"text": "FilterCondition"
},
" | ",
"AndCondition",
" | ",
"OrCondition",
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.NeverCondition",
"text": "NeverCondition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.AlwaysCondition",
"text": "AlwaysCondition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/routing/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig",
"type": "Interface",
"tags": [],
"label": "SetProcessorConfig",
"description": [
"\nSet processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.SetProcessorConfig",
"text": "SetProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig.override",
"type": "CompoundType",
"tags": [],
"label": "override",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig.ignore_empty_value",
"type": "CompoundType",
"tags": [],
"label": "ignore_empty_value",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorConfig.media_type",
"type": "string",
"tags": [],
"label": "media_type",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "SetProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SetProcessorDefinition.set",
"type": "Object",
"tags": [],
"label": "set",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.SetProcessorConfig",
"text": "SetProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnaryFilterCondition",
"type": "Interface",
"tags": [],
"label": "UnaryFilterCondition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnaryFilterCondition.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnaryFilterCondition.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"\"exists\" | \"notExists\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorConfig",
"type": "Interface",
"tags": [],
"label": "UrlDecodeProcessorConfig",
"description": [
"\nURL Decode processor"
],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UrlDecodeProcessorConfig",
"text": "UrlDecodeProcessorConfig"
},
" extends ",
"ProcessorBase"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "UrlDecodeProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UrlDecodeProcessorDefinition.urldecode",
"type": "Object",
"tags": [],
"label": "urldecode",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UrlDecodeProcessorConfig",
"text": "UrlDecodeProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig",
"type": "Interface",
"tags": [],
"label": "UserAgentProcessorConfig",
"description": [
"\nUser agent processor"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig.target_field",
"type": "string",
"tags": [],
"label": "target_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig.regex_file",
"type": "string",
"tags": [],
"label": "regex_file",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig.properties",
"type": "Array",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorConfig.ignore_missing",
"type": "CompoundType",
"tags": [],
"label": "ignore_missing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorDefinition",
"type": "Interface",
"tags": [],
"label": "UserAgentProcessorDefinition",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UserAgentProcessorDefinition.user_agent",
"type": "Object",
"tags": [],
"label": "user_agent",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UserAgentProcessorConfig",
"text": "UserAgentProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Condition",
"type": "Type",
"tags": [],
"label": "Condition",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.FilterCondition",
"text": "FilterCondition"
},
" | ",
"AndCondition",
" | ",
"OrCondition",
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.NeverCondition",
"text": "NeverCondition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.AlwaysCondition",
"text": "AlwaysCondition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ElasticsearchProcessorType",
"type": "Type",
"tags": [],
"label": "ElasticsearchProcessorType",
"description": [],
"signature": [
"keyof ",
"IngestProcessorContainer"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/ingest_pipeline_processors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FieldDefinitionConfig",
"type": "Type",
"tags": [],
"label": "FieldDefinitionConfig",
"description": [],
"signature": [
"(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FieldDefinitionConfigAdvancedParameters",
"type": "Type",
"tags": [],
"label": "FieldDefinitionConfigAdvancedParameters",
"description": [],
"signature": [
"{}"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FilterCondition",
"type": "Type",
"tags": [],
"label": "FilterCondition",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.BinaryFilterCondition",
"text": "BinaryFilterCondition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnaryFilterCondition",
"text": "UnaryFilterCondition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.FlattenRecord",
"type": "Type",
"tags": [],
"label": "FlattenRecord",
"description": [],
"signature": [
"{ [x: string]: ",
"Primitive",
" | ",
"Primitive",
"[]; [x: number]: ",
"Primitive",
" | ",
"Primitive",
"[]; [x: symbol]: ",
"Primitive",
" | ",
"Primitive",
"[]; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/record_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Ingest",
"type": "Type",
"tags": [],
"label": "Ingest",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnwiredIngest",
"text": "UnwiredIngest"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.WiredIngest",
"text": "WiredIngest"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestStreamEffectiveLifecycle",
"type": "Type",
"tags": [],
"label": "IngestStreamEffectiveLifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnwiredIngestStreamEffectiveLifecycle",
"text": "UnwiredIngestStreamEffectiveLifecycle"
},
" | ",
"WiredIngestStreamEffectiveLifecycle"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestStreamLifecycle",
"type": "Type",
"tags": [],
"label": "IngestStreamLifecycle",
"description": [],
"signature": [
"IngestStreamLifecycleDSL",
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamLifecycleILM",
"text": "IngestStreamLifecycleILM"
},
" | ",
"IngestStreamLifecycleInherit"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.InheritedFieldDefinitionConfig",
"type": "Type",
"tags": [],
"label": "InheritedFieldDefinitionConfig",
"description": [],
"signature": [
"(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { from: string; alias_for?: string | undefined; }) | ({ type: \"system\"; } & { from: string; alias_for?: string | undefined; })"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.keepFields",
"type": "Array",
"tags": [],
"label": "keepFields",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.NamedFieldDefinitionConfig",
"type": "Type",
"tags": [],
"label": "NamedFieldDefinitionConfig",
"description": [],
"signature": [
"(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | ({ type: \"system\"; } & { name: string; })"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.namespacePrefixes",
"type": "Array",
"tags": [],
"label": "namespacePrefixes",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/helpers/namespaced_ecs.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.PhaseName",
"type": "Type",
"tags": [],
"label": "PhaseName",
"description": [],
"signature": [
"\"delete\" | \"warm\" | \"hot\" | \"frozen\" | \"cold\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ProcessorConfig",
"type": "Type",
"tags": [],
"label": "ProcessorConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GrokProcessorConfig",
"text": "GrokProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DateProcessorConfig",
"text": "DateProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DissectProcessorConfig",
"text": "DissectProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.KvProcessorConfig",
"text": "KvProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GeoIpProcessorConfig",
"text": "GeoIpProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RenameProcessorConfig",
"text": "RenameProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.SetProcessorConfig",
"text": "SetProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ManualIngestPipelineProcessorConfig",
"text": "ManualIngestPipelineProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UrlDecodeProcessorConfig",
"text": "UrlDecodeProcessorConfig"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UserAgentProcessorConfig",
"text": "UserAgentProcessorConfig"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ProcessorDefinition",
"type": "Type",
"tags": [],
"label": "ProcessorDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DateProcessorDefinition",
"text": "DateProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.DissectProcessorDefinition",
"text": "DissectProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GrokProcessorDefinition",
"text": "GrokProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.KvProcessorDefinition",
"text": "KvProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.GeoIpProcessorDefinition",
"text": "GeoIpProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RenameProcessorDefinition",
"text": "RenameProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.SetProcessorDefinition",
"text": "SetProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ManualIngestPipelineProcessorDefinition",
"text": "ManualIngestPipelineProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UrlDecodeProcessorDefinition",
"text": "UrlDecodeProcessorDefinition"
},
" | ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UserAgentProcessorDefinition",
"text": "UserAgentProcessorDefinition"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ProcessorDefinitionWithId",
"type": "Type",
"tags": [],
"label": "ProcessorDefinitionWithId",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinition",
"text": "ProcessorDefinition"
},
" & { id: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ProcessorType",
"type": "Type",
"tags": [],
"label": "ProcessorType",
"description": [],
"signature": [
"\"date\" | \"set\" | \"user_agent\" | \"rename\" | \"grok\" | \"dissect\" | \"kv\" | \"geoip\" | \"manual_ingest_pipeline\" | \"urldecode\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.ProcessorTypeOf",
"type": "Type",
"tags": [],
"label": "ProcessorTypeOf",
"description": [],
"signature": [
"UnionKeysOf<TProcessorDefinition> & ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorType",
"text": "ProcessorType"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SampleDocument",
"type": "Type",
"tags": [],
"label": "SampleDocument",
"description": [],
"signature": [
"RecursiveRecord"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/record_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SignificantEventsGetResponse",
"type": "Type",
"tags": [],
"label": "SignificantEventsGetResponse",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.SignificantEventsResponse",
"text": "SignificantEventsResponse"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/api/significant_events/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.SignificantEventsResponse",
"type": "Type",
"tags": [],
"label": "SignificantEventsResponse",
"description": [],
"signature": [
"StreamQueryKql",
" & { occurrences: { date: string; count: number; }[]; change_points: { type: Partial<Record<ChangePointsType, Partial<{ p_value: number; r_value: number; change_point: number; trend: string; }>>>; }; }"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/api/significant_events/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.StreamQuery",
"type": "Type",
"tags": [],
"label": "StreamQuery",
"description": [],
"signature": [
"StreamQueryKql"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/queries/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnaryOperator",
"type": "Type",
"tags": [],
"label": "UnaryOperator",
"description": [],
"signature": [
"\"exists\" | \"notExists\""
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnwiredIngest",
"type": "Type",
"tags": [],
"label": "UnwiredIngest",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
" & ",
"IngestUnwired"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/unwired.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnwiredIngestStreamEffectiveLifecycle",
"type": "Type",
"tags": [],
"label": "UnwiredIngestStreamEffectiveLifecycle",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestStreamLifecycle",
"text": "IngestStreamLifecycle"
},
" | ",
"IngestStreamLifecycleError",
" | ",
"IngestStreamLifecycleDisabled"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/lifecycle/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.WiredIngest",
"type": "Type",
"tags": [],
"label": "WiredIngest",
"description": [],
"signature": [
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
" & IngestWired"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/wired.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.conditionSchema",
"type": "Object",
"tags": [],
"label": "conditionSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Condition",
"text": "Condition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/conditions/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.contentPackSchema",
"type": "Object",
"tags": [],
"label": "contentPackSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ContentPack",
"text": "ContentPack"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ContentPack",
"text": "ContentPack"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/content/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.elasticsearchProcessorTypes",
"type": "Object",
"tags": [],
"label": "elasticsearchProcessorTypes",
"description": [],
"signature": [
"readonly [\"append\", \"attachment\", \"bytes\", \"circle\", \"community_id\", \"convert\", \"csv\", \"date\", \"date_index_name\", \"dissect\", \"dot_expander\", \"drop\", \"enrich\", \"fail\", \"fingerprint\", \"foreach\", \"ip_location\", \"geo_grid\", \"geoip\", \"grok\", \"gsub\", \"html_strip\", \"inference\", \"join\", \"json\", \"kv\", \"lowercase\", \"network_direction\", \"pipeline\", \"redact\", \"registered_domain\", \"remove\", \"rename\", \"reroute\", \"script\", \"set\", \"set_security_user\", \"sort\", \"split\", \"terminate\", \"trim\", \"uppercase\", \"urldecode\", \"uri_parts\", \"user_agent\"]"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/ingest_pipeline_processors.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.fieldDefinitionConfigSchema",
"type": "Object",
"tags": [],
"label": "fieldDefinitionConfigSchema",
"description": [],
"signature": [
"Zod.ZodType<(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }, Zod.ZodTypeDef, (",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; }) | { type: \"system\"; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.flattenRecord",
"type": "Object",
"tags": [],
"label": "flattenRecord",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.FlattenRecord",
"text": "FlattenRecord"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.FlattenRecord",
"text": "FlattenRecord"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/record_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Group",
"type": "Object",
"tags": [],
"label": "Group",
"description": [],
"signature": [
"Validation",
"<unknown, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Group",
"text": "Group"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/group/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Ingest",
"type": "Object",
"tags": [],
"label": "Ingest",
"description": [],
"signature": [
"Validation",
"<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
", ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Ingest",
"text": "Ingest"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.IngestBase",
"type": "Object",
"tags": [],
"label": "IngestBase",
"description": [],
"signature": [
"Validation",
"<unknown, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/base.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.namedFieldDefinitionConfigSchema",
"type": "Object",
"tags": [],
"label": "namedFieldDefinitionConfigSchema",
"description": [],
"signature": [
"Zod.ZodType<(",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | ({ type: \"system\"; } & { name: string; }), Zod.ZodTypeDef, (",
"MappingBooleanProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingKeywordProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingMatchOnlyTextProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDateProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingIpProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingDoubleNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | (",
"MappingLongNumberProperty",
" & { type: \"boolean\" | \"ip\" | \"keyword\" | \"date\" | \"long\" | \"double\" | \"match_only_text\"; format?: string | undefined; } & { name: string; }) | ({ type: \"system\"; } & { name: string; })>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/fields/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.processorDefinitionSchema",
"type": "Object",
"tags": [],
"label": "processorDefinitionSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinition",
"text": "ProcessorDefinition"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinition",
"text": "ProcessorDefinition"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.processorWithIdDefinitionSchema",
"type": "Object",
"tags": [],
"label": "processorWithIdDefinitionSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinitionWithId",
"text": "ProcessorDefinitionWithId"
},
", Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.ProcessorDefinitionWithId",
"text": "ProcessorDefinitionWithId"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/processors/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.recursiveRecord",
"type": "Object",
"tags": [],
"label": "recursiveRecord",
"description": [],
"signature": [
"Zod.ZodType<",
"RecursiveRecord",
", Zod.ZodTypeDef, ",
"RecursiveRecord",
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/shared/record_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.routingDefinitionListSchema",
"type": "Object",
"tags": [],
"label": "routingDefinitionListSchema",
"description": [],
"signature": [
"Zod.ZodType<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RoutingDefinition",
"text": "RoutingDefinition"
},
"[], Zod.ZodTypeDef, ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.RoutingDefinition",
"text": "RoutingDefinition"
},
"[]>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/routing/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.streamQuerySchema",
"type": "Object",
"tags": [],
"label": "streamQuerySchema",
"description": [],
"signature": [
"Zod.ZodType<",
"StreamQueryKql",
", Zod.ZodTypeDef, ",
"StreamQueryKql",
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/queries/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.Streams",
"type": "Object",
"tags": [],
"label": "Streams",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.Streams",
"text": "Streams"
}
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/streams.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.UnwiredIngest",
"type": "Object",
"tags": [],
"label": "UnwiredIngest",
"description": [],
"signature": [
"Validation",
"<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
", ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.UnwiredIngest",
"text": "UnwiredIngest"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/unwired.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.upsertStreamQueryRequestSchema",
"type": "Object",
"tags": [],
"label": "upsertStreamQueryRequestSchema",
"description": [],
"signature": [
"Zod.ZodObject<{ title: Zod.ZodEffects<Zod.ZodString, string, string>; kql: Zod.ZodObject<{ query: Zod.ZodEffects<Zod.ZodString, string, string>; }, \"strip\", Zod.ZodTypeAny, { query: string; }, { query: string; }>; }, \"strip\", Zod.ZodTypeAny, { title: string; kql: { query: string; }; }, { title: string; kql: { query: string; }; }>"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/queries/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/streams-schema",
"id": "def-common.WiredIngest",
"type": "Object",
"tags": [],
"label": "WiredIngest",
"description": [],
"signature": [
"Validation",
"<",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.IngestBase",
"text": "IngestBase"
},
", ",
{
"pluginId": "@kbn/streams-schema",
"scope": "common",
"docId": "kibKbnStreamsSchemaPluginApi",
"section": "def-common.WiredIngest",
"text": "WiredIngest"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-streams-schema/src/models/ingest/wired.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink