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

1269 lines
No EOL
46 KiB
JSON
Raw Blame History

{
"id": "@kbn/securitysolution-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError",
"type": "Class",
"tags": [],
"label": "FormattedAxiosError",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.FormattedAxiosError",
"text": "FormattedAxiosError"
},
" extends Error"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ method: string; url: string; data: unknown; }"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.response",
"type": "Object",
"tags": [],
"label": "response",
"description": [],
"signature": [
"{ status: number; statusText: string; data: any; }"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "axiosError",
"description": [],
"signature": [
"AxiosError",
"<unknown, any>"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.toJSON",
"type": "Function",
"tags": [],
"label": "toJSON",
"description": [],
"signature": [
"() => { message: string; request: { method: string; url: string; data: unknown; }; response: { status: number; statusText: string; data: any; }; }"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FormattedAxiosError.toString",
"type": "Function",
"tags": [],
"label": "toString",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.addIdToItem",
"type": "Function",
"tags": [],
"label": "addIdToItem",
"description": [],
"signature": [
"<T>(item: NotArray<T>) => T"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.addIdToItem.$1",
"type": "Uncategorized",
"tags": [],
"label": "item",
"description": [],
"signature": [
"NotArray<T>"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.catchAxiosErrorFormatAndThrow",
"type": "Function",
"tags": [],
"label": "catchAxiosErrorFormatAndThrow",
"description": [
"\nUsed with `promise.catch()`, it will format the Axios error to a new error and will re-throw"
],
"signature": [
"(error: Error) => never"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.catchAxiosErrorFormatAndThrow.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/axios/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.computeIsESQLQueryAggregating",
"type": "Function",
"tags": [],
"label": "computeIsESQLQueryAggregating",
"description": [
"\ncompute if esqlQuery is aggregating/grouping, i.e. using STATS...BY command"
],
"signature": [
"(esqlQuery: string) => boolean"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.computeIsESQLQueryAggregating.$1",
"type": "string",
"tags": [],
"label": "esqlQuery",
"description": [],
"signature": [
"string"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"boolean"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.debounceAsync",
"type": "Function",
"tags": [],
"label": "debounceAsync",
"description": [
"\nUnlike lodash's debounce, which resolves intermediate calls with the most\nrecent value, this implementation waits to resolve intermediate calls until\nthe next invocation resolves.\n"
],
"signature": [
"(fn: (...args: Args) => Result, intervalMs: number) => (...args: Args) => Promise<Awaited<Result>>"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/debounce_async/debounce_async.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.debounceAsync.$1",
"type": "Function",
"tags": [],
"label": "fn",
"description": [
"an async function"
],
"signature": [
"(...args: Args) => Result"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/debounce_async/debounce_async.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.debounceAsync.$2",
"type": "number",
"tags": [],
"label": "intervalMs",
"description": [],
"signature": [
"number"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/debounce_async/debounce_async.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"A debounced async function that resolves on the next invocation"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getIndexListFromEsqlQuery",
"type": "Function",
"tags": [],
"label": "getIndexListFromEsqlQuery",
"description": [
"\nparses ES|QL query and returns array of indices"
],
"signature": [
"(query: string | undefined) => string[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getIndexListFromEsqlQuery.$1",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getIndexListFromIndexString",
"type": "Function",
"tags": [],
"label": "getIndexListFromIndexString",
"description": [
"\ntransforms sting of indices, separated by commas to array\nindex*, index2* => [index*, index2*]"
],
"signature": [
"(indexString: string | undefined) => string[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getIndexListFromIndexString.$1",
"type": "string",
"tags": [],
"label": "indexString",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getMvExpandFields",
"type": "Function",
"tags": [],
"label": "getMvExpandFields",
"description": [],
"signature": [
"(query: string) => string[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_mv_expand_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.getMvExpandFields.$1",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_mv_expand_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.hasSimpleExecutableName",
"type": "Function",
"tags": [],
"label": "hasSimpleExecutableName",
"description": [],
"signature": [
"({ os, type, value, }: { os: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
},
"; type: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.EntryTypes",
"text": "EntryTypes"
},
"; value: string; }) => boolean | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.hasSimpleExecutableName.$1",
"type": "Object",
"tags": [],
"label": "{\n os,\n type,\n value,\n}",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.hasSimpleExecutableName.$1.os",
"type": "Enum",
"tags": [],
"label": "os",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.hasSimpleExecutableName.$1.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"wildcard\" | \"match\" | \"match_any\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.hasSimpleExecutableName.$1.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isAggregatingQuery",
"type": "Function",
"tags": [],
"label": "isAggregatingQuery",
"description": [],
"signature": [
"(astExpression: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => boolean"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isAggregatingQuery.$1",
"type": "Object",
"tags": [],
"label": "astExpression",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid",
"type": "Function",
"tags": [],
"label": "isPathValid",
"description": [],
"signature": [
"({ os, field, type, value, }: { os: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
},
"; field: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.AllConditionEntryFields",
"text": "AllConditionEntryFields"
},
"; type: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.EntryTypes",
"text": "EntryTypes"
},
"; value: string; }) => boolean"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid.$1",
"type": "Object",
"tags": [],
"label": "{\n os,\n field,\n type,\n value,\n}",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid.$1.os",
"type": "Enum",
"tags": [],
"label": "os",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid.$1.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.TrustedAppConditionEntryField",
"text": "TrustedAppConditionEntryField"
},
" | ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.BlocklistConditionEntryField",
"text": "BlocklistConditionEntryField"
},
" | \"file.path.text\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid.$1.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"wildcard\" | \"match\" | \"match_any\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.isPathValid.$1.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.parseEsqlQuery",
"type": "Function",
"tags": [],
"label": "parseEsqlQuery",
"description": [
"\ncheck if esql query valid for Security rule:\n- if it's non aggregation query it must have metadata operator"
],
"signature": [
"(query: string) => ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.ParseEsqlQueryResult",
"text": "ParseEsqlQueryResult"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.parseEsqlQuery.$1",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.removeIdFromItem",
"type": "Function",
"tags": [],
"label": "removeIdFromItem",
"description": [
"\nThis is to reverse the id you added to your arrays for ReactJS keys."
],
"signature": [
"<T>(item: NotArray<T>) => T | Pick<T & { id?: string | undefined; }, Exclude<keyof T, \"id\">>"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.removeIdFromItem.$1",
"type": "Uncategorized",
"tags": [],
"label": "item",
"description": [
"The item to remove the id from."
],
"signature": [
"NotArray<T>"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.transformDataToNdjson",
"type": "Function",
"tags": [],
"label": "transformDataToNdjson",
"description": [],
"signature": [
"(data: unknown[]) => string"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/transform_data_to_ndjson/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.transformDataToNdjson.$1",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
"unknown[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/transform_data_to_ndjson/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateFilePathInput",
"type": "Function",
"tags": [],
"label": "validateFilePathInput",
"description": [],
"signature": [
"({ os, value, }: { os: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
},
"; value: string; }) => string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateFilePathInput.$1",
"type": "Object",
"tags": [],
"label": "{\n os,\n value,\n}",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateFilePathInput.$1.os",
"type": "Enum",
"tags": [],
"label": "os",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateFilePathInput.$1.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateHasWildcardWithWrongOperator",
"type": "Function",
"tags": [],
"label": "validateHasWildcardWithWrongOperator",
"description": [],
"signature": [
"({ operator, value, }: { operator: \"wildcard\" | \"match\" | \"nested\" | \"exists\" | \"match_any\"; value: string | string[]; }) => boolean"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateHasWildcardWithWrongOperator.$1",
"type": "Object",
"tags": [],
"label": "{\n operator,\n value,\n}",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateHasWildcardWithWrongOperator.$1.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"\"wildcard\" | \"match\" | \"nested\" | \"exists\" | \"match_any\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateHasWildcardWithWrongOperator.$1.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validatePotentialWildcardInput",
"type": "Function",
"tags": [],
"label": "validatePotentialWildcardInput",
"description": [],
"signature": [
"({ field, os, value, }: { field?: string | undefined; os: ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
},
"; value?: string | undefined; }) => string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validatePotentialWildcardInput.$1",
"type": "Object",
"tags": [],
"label": "{\n field = '',\n os,\n value = '',\n}",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validatePotentialWildcardInput.$1.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validatePotentialWildcardInput.$1.os",
"type": "Enum",
"tags": [],
"label": "os",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.OperatingSystem",
"text": "OperatingSystem"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validatePotentialWildcardInput.$1.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateWildcardInput",
"type": "Function",
"tags": [],
"label": "validateWildcardInput",
"description": [],
"signature": [
"(value: string | string[]) => string | undefined"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.validateWildcardInput.$1",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.ParseEsqlQueryResult",
"type": "Interface",
"tags": [],
"label": "ParseEsqlQueryResult",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.ParseEsqlQueryResult.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.ParseEsqlQueryResult.isEsqlQueryAggregating",
"type": "boolean",
"tags": [],
"label": "isEsqlQueryAggregating",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.ParseEsqlQueryResult.hasMetadataOperator",
"type": "boolean",
"tags": [],
"label": "hasMetadataOperator",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.ConditionEntryField",
"type": "Enum",
"tags": [],
"label": "ConditionEntryField",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.EntryFieldType",
"type": "Enum",
"tags": [],
"label": "EntryFieldType",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.OperatingSystem",
"type": "Enum",
"tags": [],
"label": "OperatingSystem",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.AllConditionEntryFields",
"type": "Type",
"tags": [],
"label": "AllConditionEntryFields",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.TrustedAppConditionEntryField",
"text": "TrustedAppConditionEntryField"
},
" | ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.BlocklistConditionEntryField",
"text": "BlocklistConditionEntryField"
},
" | \"file.path.text\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.BlocklistConditionEntryField",
"type": "Type",
"tags": [],
"label": "BlocklistConditionEntryField",
"description": [],
"signature": [
"\"file.path\" | \"file.Ext.code_signature\" | \"file.hash.*\" | \"file.path.caseless\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.EntryTypes",
"type": "Type",
"tags": [],
"label": "EntryTypes",
"description": [],
"signature": [
"\"wildcard\" | \"match\" | \"match_any\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.EventFiltersTypes",
"type": "Type",
"tags": [],
"label": "EventFiltersTypes",
"description": [],
"signature": [
"\"nested\" | \"exists\" | ",
{
"pluginId": "@kbn/securitysolution-utils",
"scope": "common",
"docId": "kibKbnSecuritysolutionUtilsPluginApi",
"section": "def-common.EntryTypes",
"text": "EntryTypes"
}
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.FILEPATH_WARNING",
"type": "string",
"tags": [],
"label": "FILEPATH_WARNING",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.TrustedAppConditionEntryField",
"type": "Type",
"tags": [],
"label": "TrustedAppConditionEntryField",
"description": [],
"signature": [
"\"process.hash.*\" | \"process.executable.caseless\" | \"process.Ext.code_signature\" | \"process.code_signature\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.TrustedAppEntryTypes",
"type": "Type",
"tags": [],
"label": "TrustedAppEntryTypes",
"description": [],
"signature": [
"\"wildcard\" | \"match\""
],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-utils",
"id": "def-common.WILDCARD_WARNING",
"type": "string",
"tags": [],
"label": "WILDCARD_WARNING",
"description": [],
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/path_validations/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink