kibana/api_docs/kbn_securitysolution_list_utils.devdocs.json
2022-10-29 00:46:56 -04:00

3872 lines
No EOL
157 KiB
JSON

{
"id": "@kbn/securitysolution-list-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.addIdToEntries",
"type": "Function",
"tags": [],
"label": "addIdToEntries",
"description": [],
"signature": [
"(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.addIdToEntries.$1",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.containsValueListEntry",
"type": "Function",
"tags": [],
"label": "containsValueListEntry",
"description": [],
"signature": [
"(items: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
},
"[]) => boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.containsValueListEntry.$1",
"type": "Array",
"tags": [],
"label": "items",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.filterExceptionItems",
"type": "Function",
"tags": [],
"label": "filterExceptionItems",
"description": [],
"signature": [
"(exceptions: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
},
"[]) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderReturnExceptionItem",
"text": "ExceptionsBuilderReturnExceptionItem"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.filterExceptionItems.$1",
"type": "Array",
"tags": [],
"label": "exceptions",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getCorrespondingKeywordField",
"type": "Function",
"tags": [],
"label": "getCorrespondingKeywordField",
"description": [
"\nFields of type 'text' do not generate autocomplete values, we want\nto find it's corresponding keyword type (if available) which does\ngenerate autocomplete values\n"
],
"signature": [
"({ fields, selectedField, }: { fields: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
"[]; selectedField: string | undefined; }) => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
" | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getCorrespondingKeywordField.$1",
"type": "Object",
"tags": [],
"label": "{\n fields,\n selectedField,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getCorrespondingKeywordField.$1.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getCorrespondingKeywordField.$1.selectedField",
"type": "string",
"tags": [],
"label": "selectedField",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getDefaultEmptyEntry",
"type": "Function",
"tags": [],
"label": "getDefaultEmptyEntry",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.EmptyEntry",
"text": "EmptyEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getDefaultNestedEmptyEntry",
"type": "Function",
"tags": [],
"label": "getDefaultNestedEmptyEntry",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.EmptyNestedEntry",
"text": "EmptyNestedEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryFromOperator",
"type": "Function",
"tags": [],
"label": "getEntryFromOperator",
"description": [
"\nOn operator change, determines whether value needs to be cleared or not\n"
],
"signature": [
"(selectedOperator: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
", currentEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
") => ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryFromOperator.$1",
"type": "Object",
"tags": [],
"label": "selectedOperator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryFromOperator.$2",
"type": "Object",
"tags": [],
"label": "currentEntry",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnFieldChange",
"type": "Function",
"tags": [],
"label": "getEntryOnFieldChange",
"description": [
"\nDetermines proper entry update when user selects new field\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newField: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
") => { index: number; updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnFieldChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnFieldChange.$2",
"type": "Object",
"tags": [],
"label": "newField",
"description": [
"- newly selected field"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnListChange",
"type": "Function",
"tags": [],
"label": "getEntryOnListChange",
"description": [
"\nDetermines proper entry update when user updates value\nwhen operator is of type \"list\"\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newField: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnListChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnListChange.$2",
"type": "Object",
"tags": [],
"label": "newField",
"description": [
"- newly selected list"
],
"signature": [
"{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; updated_at: string; updated_by: string; version: number; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchAnyChange",
"type": "Function",
"tags": [],
"label": "getEntryOnMatchAnyChange",
"description": [
"\nDetermines proper entry update when user updates value\nwhen operator is of type \"match_any\"\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newField: string[]) => { index: number; updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchAnyChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchAnyChange.$2",
"type": "Array",
"tags": [],
"label": "newField",
"description": [
"- newly entered value"
],
"signature": [
"string[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchChange",
"type": "Function",
"tags": [],
"label": "getEntryOnMatchChange",
"description": [
"\nDetermines proper entry update when user updates value\nwhen operator is of type \"match\"\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newField: string) => { index: number; updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnMatchChange.$2",
"type": "string",
"tags": [],
"label": "newField",
"description": [
"- newly entered value"
],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnOperatorChange",
"type": "Function",
"tags": [],
"label": "getEntryOnOperatorChange",
"description": [
"\nDetermines proper entry update when user selects new operator\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newOperator: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
") => { updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; index: number; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnOperatorChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnOperatorChange.$2",
"type": "Object",
"tags": [],
"label": "newOperator",
"description": [
"- newly selected operator"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnWildcardChange",
"type": "Function",
"tags": [],
"label": "getEntryOnWildcardChange",
"description": [
"\nDetermines proper entry update when user updates value\nwhen operator is of type \"wildcard\"\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", newField: string) => { index: number; updatedEntry: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnWildcardChange.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"- current exception item entry values"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryOnWildcardChange.$2",
"type": "string",
"tags": [],
"label": "newField",
"description": [
"- newly entered value"
],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryValue",
"type": "Function",
"tags": [],
"label": "getEntryValue",
"description": [
"\nReturns the fields corresponding value for an entry\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
") => string | string[] | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getEntryValue.$1",
"type": "CompoundType",
"tags": [],
"label": "item",
"description": [
"a single ExceptionItem entry"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getExceptionListType",
"type": "Function",
"tags": [],
"label": "getExceptionListType",
"description": [],
"signature": [
"({ savedObjectType, }: { savedObjectType: string; }) => \"single\" | \"agnostic\""
],
"path": "packages/kbn-securitysolution-list-utils/src/get_exception_list_type/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getExceptionListType.$1",
"type": "Object",
"tags": [],
"label": "{\n savedObjectType,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_exception_list_type/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getExceptionListType.$1.savedObjectType",
"type": "string",
"tags": [],
"label": "savedObjectType",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_exception_list_type/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getExceptionOperatorSelect",
"type": "Function",
"tags": [],
"label": "getExceptionOperatorSelect",
"description": [
"\nDetermines operator selection (is/is not/is one of, etc.)\nDefault operator is \"is\"\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
") => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getExceptionOperatorSelect.$1",
"type": "CompoundType",
"tags": [],
"label": "item",
"description": [
"a single ExceptionItem entry"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns",
"type": "Function",
"tags": [],
"label": "getFilteredIndexPatterns",
"description": [
"\nReturns filtered index patterns based on the field - if a user selects to\nadd nested entry, should only show nested fields, if item is the parent\nfield of a nested entry, we only display the parent field\n"
],
"signature": [
"(patterns: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", type: \"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\", preFilter?: ((i: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", t: \"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\", o?: (\"windows\" | \"linux\" | \"macos\")[] | undefined) => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
") | undefined, osTypes?: (\"windows\" | \"linux\" | \"macos\")[] | undefined) => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns.$1",
"type": "Object",
"tags": [],
"label": "patterns",
"description": [
"DataViewBase containing available fields on rule index"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns.$2",
"type": "Object",
"tags": [],
"label": "item",
"description": [
"exception item entry\nset to add a nested field"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns.$3",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\""
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns.$4",
"type": "Function",
"tags": [],
"label": "preFilter",
"description": [],
"signature": [
"((i: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", t: \"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\", o?: (\"windows\" | \"linux\" | \"macos\")[] | undefined) => ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
") | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilteredIndexPatterns.$5",
"type": "Array",
"tags": [],
"label": "osTypes",
"description": [],
"signature": [
"(\"windows\" | \"linux\" | \"macos\")[] | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilters",
"type": "Function",
"tags": [],
"label": "getFilters",
"description": [],
"signature": [
"({ filters, namespaceTypes, hideLists }: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.GetFiltersParams",
"text": "GetFiltersParams"
},
") => string"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFilters.$1",
"type": "Object",
"tags": [],
"label": "{ filters, namespaceTypes, hideLists }",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.GetFiltersParams",
"text": "GetFiltersParams"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries",
"type": "Function",
"tags": [],
"label": "getFormattedBuilderEntries",
"description": [
"\nFormats the entries to be easily usable for the UI, most of the\ncomplexity was introduced with nested fields\n"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", entries: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"[], allowCustomFieldOptions: boolean, parent?: { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | undefined, parentIndex?: number | undefined) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries.$2",
"type": "Array",
"tags": [],
"label": "entries",
"description": [
"exception item entries"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries.$3",
"type": "boolean",
"tags": [],
"label": "allowCustomFieldOptions",
"description": [
"determines if field must be found to match in indexPattern or not"
],
"signature": [
"boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries.$4",
"type": "Object",
"tags": [],
"label": "parent",
"description": [
"nested entries hold copy of their parent for use in various logic"
],
"signature": [
"{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntries.$5",
"type": "number",
"tags": [],
"label": "parentIndex",
"description": [
"corresponds to the entry index, this might seem obvious, but\nwas added to ensure that nested items could be identified with their parent entry"
],
"signature": [
"number | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry",
"type": "Function",
"tags": [],
"label": "getFormattedBuilderEntry",
"description": [
"\nFormats the entry into one that is easily usable for the UI, most of the\ncomplexity was introduced with nested fields\n"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
},
", item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
", itemIndex: number, parent: { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | undefined, parentIndex: number | undefined, allowCustomFieldOptions: boolean) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewBase",
"text": "DataViewBase"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$2",
"type": "CompoundType",
"tags": [],
"label": "item",
"description": [
"exception item entry"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$3",
"type": "number",
"tags": [],
"label": "itemIndex",
"description": [
"entry index"
],
"signature": [
"number"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$4",
"type": "Object",
"tags": [],
"label": "parent",
"description": [
"nested entries hold copy of their parent for use in various logic"
],
"signature": [
"{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$5",
"type": "number",
"tags": [],
"label": "parentIndex",
"description": [
"corresponds to the entry index, this might seem obvious, but\nwas added to ensure that nested items could be identified with their parent entry"
],
"signature": [
"number | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getFormattedBuilderEntry.$6",
"type": "boolean",
"tags": [],
"label": "allowCustomFieldOptions",
"description": [
"determines if field must be found to match in indexPattern or not"
],
"signature": [
"boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getGeneralFilters",
"type": "Function",
"tags": [],
"label": "getGeneralFilters",
"description": [],
"signature": [
"(filters: ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
},
", namespaceTypes: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.SavedObjectType",
"text": "SavedObjectType"
},
"[]) => string"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_general_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getGeneralFilters.$1",
"type": "Object",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/get_general_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getGeneralFilters.$2",
"type": "Array",
"tags": [],
"label": "namespaceTypes",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.SavedObjectType",
"text": "SavedObjectType"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_general_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getIdsAndNamespaces",
"type": "Function",
"tags": [],
"label": "getIdsAndNamespaces",
"description": [],
"signature": [
"({ lists, showDetection, showEndpoint, }: { lists: ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListIdentifiers",
"text": "ExceptionListIdentifiers"
},
"[]; showDetection: boolean; showEndpoint: boolean; }) => { ids: string[]; namespaces: (\"single\" | \"agnostic\")[]; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getIdsAndNamespaces.$1",
"type": "Object",
"tags": [],
"label": "{\n lists,\n showDetection,\n showEndpoint,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getIdsAndNamespaces.$1.lists",
"type": "Array",
"tags": [],
"label": "lists",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListIdentifiers",
"text": "ExceptionListIdentifiers"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getIdsAndNamespaces.$1.showDetection",
"type": "boolean",
"tags": [],
"label": "showDetection",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getIdsAndNamespaces.$1.showEndpoint",
"type": "boolean",
"tags": [],
"label": "showEndpoint",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_ids_and_namespaces/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getNewExceptionItem",
"type": "Function",
"tags": [],
"label": "getNewExceptionItem",
"description": [],
"signature": [
"({ listId, namespaceType, name, }: { listId: string | undefined; namespaceType: \"single\" | \"agnostic\" | undefined; name: string; }) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.CreateExceptionListItemBuilderSchema",
"text": "CreateExceptionListItemBuilderSchema"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getNewExceptionItem.$1",
"type": "Object",
"tags": [],
"label": "{\n listId,\n namespaceType,\n name,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getNewExceptionItem.$1.listId",
"type": "string",
"tags": [],
"label": "listId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getNewExceptionItem.$1.namespaceType",
"type": "CompoundType",
"tags": [],
"label": "namespaceType",
"description": [],
"signature": [
"\"single\" | \"agnostic\" | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getNewExceptionItem.$1.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorOptions",
"type": "Function",
"tags": [],
"label": "getOperatorOptions",
"description": [
"\nDetermines which operators to make available\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
},
", listType: \"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\", isBoolean: boolean, includeValueListOperators?: boolean) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorOptions.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.FormattedBuilderEntry",
"text": "FormattedBuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorOptions.$2",
"type": "CompoundType",
"tags": [],
"label": "listType",
"description": [],
"signature": [
"\"endpoint\" | \"detection\" | \"rule_default\" | \"endpoint_trusted_apps\" | \"endpoint_events\" | \"endpoint_host_isolation_exceptions\" | \"endpoint_blocklists\""
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorOptions.$3",
"type": "boolean",
"tags": [],
"label": "isBoolean",
"description": [],
"signature": [
"boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorOptions.$4",
"type": "boolean",
"tags": [],
"label": "includeValueListOperators",
"description": [
"whether or not to include the 'is in list' and 'is not in list' operators"
],
"signature": [
"boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorType",
"type": "Function",
"tags": [],
"label": "getOperatorType",
"description": [
"\nReturns the operator type, may not need this if using io-ts types\n"
],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
") => ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getOperatorType.$1",
"type": "CompoundType",
"tags": [],
"label": "item",
"description": [
"a single ExceptionItem entry"
],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectType",
"type": "Function",
"tags": [],
"label": "getSavedObjectType",
"description": [],
"signature": [
"({ namespaceType, }: { namespaceType: \"single\" | \"agnostic\"; }) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.SavedObjectType",
"text": "SavedObjectType"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_type/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectType.$1",
"type": "Object",
"tags": [],
"label": "{\n namespaceType,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_type/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectType.$1.namespaceType",
"type": "CompoundType",
"tags": [],
"label": "namespaceType",
"description": [],
"signature": [
"\"single\" | \"agnostic\""
],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_type/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectTypes",
"type": "Function",
"tags": [],
"label": "getSavedObjectTypes",
"description": [],
"signature": [
"({ namespaceType, }: { namespaceType: (\"single\" | \"agnostic\")[]; }) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.SavedObjectType",
"text": "SavedObjectType"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectTypes.$1",
"type": "Object",
"tags": [],
"label": "{\n namespaceType,\n}",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getSavedObjectTypes.$1.namespaceType",
"type": "Array",
"tags": [],
"label": "namespaceType",
"description": [],
"signature": [
"(\"single\" | \"agnostic\")[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_saved_object_types/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getUpdatedEntriesOnDelete",
"type": "Function",
"tags": [],
"label": "getUpdatedEntriesOnDelete",
"description": [
"\nDetermines whether an entire entry, exception item, or entry within a nested\nentry needs to be removed\n"
],
"signature": [
"(exceptionItem: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
},
", entryIndex: number, nestedParentIndex: number | null) => ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getUpdatedEntriesOnDelete.$1",
"type": "CompoundType",
"tags": [],
"label": "exceptionItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionsBuilderExceptionItem",
"text": "ExceptionsBuilderExceptionItem"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getUpdatedEntriesOnDelete.$2",
"type": "number",
"tags": [],
"label": "entryIndex",
"description": [
"index of given entry, for nested entries, this will correspond\nto their parent index"
],
"signature": [
"number"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.getUpdatedEntriesOnDelete.$3",
"type": "CompoundType",
"tags": [],
"label": "nestedParentIndex",
"description": [],
"signature": [
"number | null"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.hasLargeValueList",
"type": "Function",
"tags": [],
"label": "hasLargeValueList",
"description": [],
"signature": [
"(entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]) => boolean"
],
"path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.hasLargeValueList.$1",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
"({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isEntryNested",
"type": "Function",
"tags": [],
"label": "isEntryNested",
"description": [],
"signature": [
"(item: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
") => item is { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isEntryNested.$1",
"type": "CompoundType",
"tags": [],
"label": "item",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry",
"type": "Interface",
"tags": [],
"label": "EmptyEntry",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry.operator",
"type": "Enum",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH | ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY | ",
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".WILDCARD"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyEntry.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry",
"type": "Interface",
"tags": [],
"label": "EmptyListEntry",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry.operator",
"type": "Enum",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyListEntry.list",
"type": "Object",
"tags": [],
"label": "list",
"description": [],
"signature": [
"{ id: string | undefined; type: string | undefined; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyNestedEntry",
"type": "Interface",
"tags": [],
"label": "EmptyNestedEntry",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyNestedEntry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyNestedEntry.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyNestedEntry.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".NESTED"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EmptyNestedEntry.entries",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
"(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } & { id?: string | undefined; }))[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry",
"type": "Interface",
"tags": [],
"label": "FormattedBuilderEntry",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
" | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.operator",
"type": "Object",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.nested",
"type": "CompoundType",
"tags": [],
"label": "nested",
"description": [],
"signature": [
"\"parent\" | \"child\" | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.entryIndex",
"type": "number",
"tags": [],
"label": "entryIndex",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.parent",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"{ parent: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntryNested",
"text": "BuilderEntryNested"
},
"; parentIndex: number; } | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.FormattedBuilderEntry.correspondingKeywordField",
"type": "Object",
"tags": [],
"label": "correspondingKeywordField",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
" | undefined"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.GetFiltersParams",
"type": "Interface",
"tags": [],
"label": "GetFiltersParams",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.GetFiltersParams.filters",
"type": "Object",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ExceptionListFilter",
"text": "ExceptionListFilter"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.GetFiltersParams.namespaceTypes",
"type": "Array",
"tags": [],
"label": "namespaceTypes",
"description": [],
"signature": [
"(\"single\" | \"agnostic\")[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.GetFiltersParams.hideLists",
"type": "Object",
"tags": [],
"label": "hideLists",
"description": [],
"signature": [
"readonly string[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/get_filters/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.OperatorOption",
"type": "Interface",
"tags": [],
"label": "OperatorOption",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.OperatorOption.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.OperatorOption.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.OperatorOption.operator",
"type": "Enum",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.OperatorOption.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.ALL_OPERATORS",
"type": "Array",
"tags": [],
"label": "ALL_OPERATORS",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.BuilderEntry",
"type": "Type",
"tags": [],
"label": "BuilderEntry",
"description": [],
"signature": [
"(({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.EmptyListEntry",
"text": "EmptyListEntry"
},
" | ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.EmptyEntry",
"text": "EmptyEntry"
},
" | ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntryNested",
"text": "BuilderEntryNested"
},
" | ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.EmptyNestedEntry",
"text": "EmptyNestedEntry"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.BuilderEntryNested",
"type": "Type",
"tags": [],
"label": "BuilderEntryNested",
"description": [],
"signature": [
"Omit<{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; }, \"entries\"> & { id?: string | undefined; entries: (({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } & { id?: string | undefined; }) | ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } & { id?: string | undefined; }))[]; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.CreateExceptionListItemBuilderSchema",
"type": "Type",
"tags": [],
"label": "CreateExceptionListItemBuilderSchema",
"description": [],
"signature": [
"Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"meta\" | \"entries\" | \"list_id\" | \"namespace_type\"> & { meta: { temporaryUuid: string; }; entries: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"[]; list_id: string | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.DETECTION_ENGINE_EXCEPTION_OPERATORS",
"type": "Array",
"tags": [],
"label": "DETECTION_ENGINE_EXCEPTION_OPERATORS",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EVENT_FILTERS_OPERATORS",
"type": "Array",
"tags": [],
"label": "EVENT_FILTERS_OPERATORS",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EXCEPTION_OPERATORS_ONLY_LISTS",
"type": "Array",
"tags": [],
"label": "EXCEPTION_OPERATORS_ONLY_LISTS",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.EXCEPTION_OPERATORS_SANS_LISTS",
"type": "Array",
"tags": [],
"label": "EXCEPTION_OPERATORS_SANS_LISTS",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.OperatorOption",
"text": "OperatorOption"
},
"[]"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.exceptionListAgnosticSavedObjectType",
"type": "string",
"tags": [],
"label": "exceptionListAgnosticSavedObjectType",
"description": [],
"signature": [
"\"exception-list-agnostic\""
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.ExceptionListItemBuilderSchema",
"type": "Type",
"tags": [],
"label": "ExceptionListItemBuilderSchema",
"description": [],
"signature": [
"Omit<{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; }, \"entries\"> & { entries: ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.BuilderEntry",
"text": "BuilderEntry"
},
"[]; }"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.exceptionListSavedObjectType",
"type": "string",
"tags": [],
"label": "exceptionListSavedObjectType",
"description": [],
"signature": [
"\"exception-list\""
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.ExceptionsBuilderExceptionItem",
"type": "Type",
"tags": [],
"label": "ExceptionsBuilderExceptionItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.ExceptionListItemBuilderSchema",
"text": "ExceptionListItemBuilderSchema"
},
" | ",
{
"pluginId": "@kbn/securitysolution-list-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionListUtilsPluginApi",
"section": "def-common.CreateExceptionListItemBuilderSchema",
"text": "CreateExceptionListItemBuilderSchema"
}
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.ExceptionsBuilderReturnExceptionItem",
"type": "Type",
"tags": [],
"label": "ExceptionsBuilderReturnExceptionItem",
"description": [],
"signature": [
"{ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"byte\" | \"float\" | \"half_float\" | \"integer\" | \"double_range\" | \"float_range\" | \"integer_range\" | \"long_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; list_id?: undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })"
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.SavedObjectType",
"type": "Type",
"tags": [],
"label": "SavedObjectType",
"description": [],
"signature": [
"\"exception-list-agnostic\" | \"exception-list\""
],
"path": "packages/kbn-securitysolution-list-utils/src/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotExistOperator",
"type": "Object",
"tags": [],
"label": "doesNotExistOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotExistOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotExistOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotExistOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".EXISTS"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotExistOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotMatchOperator",
"type": "Object",
"tags": [],
"label": "doesNotMatchOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotMatchOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotMatchOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotMatchOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".WILDCARD"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.doesNotMatchOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.existsOperator",
"type": "Object",
"tags": [],
"label": "existsOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.existsOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.existsOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.existsOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".EXISTS"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.existsOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isInListOperator",
"type": "Object",
"tags": [],
"label": "isInListOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isInListOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isInListOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isInListOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isInListOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotInListOperator",
"type": "Object",
"tags": [],
"label": "isNotInListOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotInListOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotInListOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotInListOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".LIST"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotInListOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOneOfOperator",
"type": "Object",
"tags": [],
"label": "isNotOneOfOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOneOfOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOneOfOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOneOfOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOneOfOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOperator",
"type": "Object",
"tags": [],
"label": "isNotOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".EXCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isNotOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOneOfOperator",
"type": "Object",
"tags": [],
"label": "isOneOfOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOneOfOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOneOfOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOneOfOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH_ANY"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOneOfOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOperator",
"type": "Object",
"tags": [],
"label": "isOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".MATCH"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.isOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.matchesOperator",
"type": "Object",
"tags": [],
"label": "matchesOperator",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.matchesOperator.message",
"type": "Any",
"tags": [],
"label": "message",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.matchesOperator.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorEnum",
"text": "ListOperatorEnum"
},
".INCLUDED"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.matchesOperator.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-io-ts-list-types",
"scope": "common",
"docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi",
"section": "def-common.ListOperatorTypeEnum",
"text": "ListOperatorTypeEnum"
},
".WILDCARD"
],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-list-utils",
"id": "def-common.matchesOperator.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "packages/kbn-securitysolution-list-utils/src/autocomplete_operators/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}