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_esql_validation_autocomplete.devdocs.json

3403 lines
No EOL
128 KiB
JSON
Raw Blame History

{
"id": "@kbn/esql-validation-autocomplete",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition",
"type": "Function",
"tags": [],
"label": "checkFunctionArgMatchesDefinition",
"description": [
"\nChecks if an AST function argument is of the correct type\ngiven the definition."
],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", parameterDefinition: { name: string; type: ",
"FunctionParameterType",
"; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; fieldsOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; mapParams?: string | undefined; }, references: ",
"ReferenceMaps",
", parentCommand: string | undefined) => boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$2",
"type": "Object",
"tags": [],
"label": "parameterDefinition",
"description": [],
"signature": [
"{ name: string; type: ",
"FunctionParameterType",
"; optional?: boolean | undefined; supportsWildcard?: boolean | undefined; constantOnly?: boolean | undefined; fieldsOnly?: boolean | undefined; acceptedValues?: string[] | undefined; literalSuggestions?: string[] | undefined; mapParams?: string | undefined; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$3",
"type": "Object",
"tags": [],
"label": "references",
"description": [],
"signature": [
"ReferenceMaps"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.checkFunctionArgMatchesDefinition.$4",
"type": "string",
"tags": [],
"label": "parentCommand",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectUserDefinedColumns",
"type": "Function",
"tags": [],
"label": "collectUserDefinedColumns",
"description": [],
"signature": [
"(ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
", fields: Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
">, queryString: string) => Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLUserDefinedColumn",
"text": "ESQLUserDefinedColumn"
},
"[]>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/user_defined_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectUserDefinedColumns.$1",
"type": "Array",
"tags": [],
"label": "ast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/user_defined_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectUserDefinedColumns.$2",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/user_defined_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.collectUserDefinedColumns.$3",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/user_defined_columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllCommands",
"type": "Function",
"tags": [],
"label": "getAllCommands",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
},
"<string>[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions",
"type": "Function",
"tags": [],
"label": "getAllFunctions",
"description": [],
"signature": [
"(options: { type: ",
"FunctionDefinitionTypes",
" | ",
"FunctionDefinitionTypes",
"[]; } | undefined) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getAllFunctions.$1.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"FunctionDefinitionTypes",
" | ",
"FunctionDefinitionTypes",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode",
"type": "Function",
"tags": [],
"label": "getColumnForASTNode",
"description": [
"\nThis function returns the userDefinedColumn or field matching a column"
],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
"ESQLIdentifier",
", { fields, userDefinedColumns }: Pick<",
"ReferenceMaps",
", \"fields\" | \"userDefinedColumns\">) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
" | ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLUserDefinedColumn",
"text": "ESQLUserDefinedColumn"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getColumnForASTNode.$2",
"type": "Object",
"tags": [],
"label": "{ fields, userDefinedColumns }",
"description": [],
"signature": [
"Pick<",
"ReferenceMaps",
", \"fields\" | \"userDefinedColumns\">"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandDefinition",
"type": "Function",
"tags": [],
"label": "getCommandDefinition",
"description": [],
"signature": [
"(name: CommandName) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
},
"<CommandName>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getCommandDefinition.$1",
"type": "Uncategorized",
"tags": [],
"label": "name",
"description": [],
"signature": [
"CommandName"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper",
"type": "Function",
"tags": [],
"label": "getFieldsByTypeHelper",
"description": [],
"signature": [
"(queryText: string, resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => { getFieldsByType: (expectedType?: string | readonly string[], ignored?: string[]) => Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[]>; getFieldsMap: () => Promise<Map<string, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
">>; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper.$1",
"type": "string",
"tags": [],
"label": "queryText",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFieldsByTypeHelper.$2",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionDefinition",
"type": "Function",
"tags": [],
"label": "getFunctionDefinition",
"description": [],
"signature": [
"(name: string) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionDefinition.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures",
"type": "Function",
"tags": [],
"label": "getFunctionSignatures",
"description": [
"\nGiven a function definition, this function will return a list of function signatures\n\nIf withTypes is true, the function will return a formal function definition with all arguments typed.\nThis is used when generating the function signature for the monaco editor. If withTypes is false, you get\nan \"injectable\" version of the signature to be used to generate test cases."
],
"signature": [
"({ name, signatures }: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
", { withTypes, capitalize }: { withTypes: boolean; capitalize?: boolean | undefined; }) => { declaration: string; }[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$1",
"type": "Object",
"tags": [],
"label": "{ name, signatures }",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2",
"type": "Object",
"tags": [],
"label": "{ withTypes, capitalize }",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2.withTypes",
"type": "boolean",
"tags": [],
"label": "withTypes",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getFunctionSignatures.$2.capitalize",
"type": "CompoundType",
"tags": [],
"label": "capitalize",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getPolicyHelper",
"type": "Function",
"tags": [],
"label": "getPolicyHelper",
"description": [],
"signature": [
"(resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => { getPolicies: () => Promise<{ name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; }[]>; getPolicyMetadata: (policyName: string) => Promise<{ name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; } | undefined>; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getPolicyHelper.$1",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getRecommendedQueries",
"type": "Function",
"tags": [],
"label": "getRecommendedQueries",
"description": [],
"signature": [
"({ fromCommand, timeField, }: { fromCommand: string; timeField?: string | undefined; }) => ({ label: string; description: string; queryString: string; sortText?: undefined; } | { label: string; description: string; queryString: string; sortText: string; })[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/recommended_queries/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getRecommendedQueries.$1",
"type": "Object",
"tags": [],
"label": "{\n fromCommand,\n timeField,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/recommended_queries/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getRecommendedQueries.$1.fromCommand",
"type": "string",
"tags": [],
"label": "fromCommand",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/recommended_queries/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getRecommendedQueries.$1.timeField",
"type": "string",
"tags": [],
"label": "timeField",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/recommended_queries/templates.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getSourcesHelper",
"type": "Function",
"tags": [],
"label": "getSourcesHelper",
"description": [],
"signature": [
"(resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => () => Promise<",
"ESQLSourceResult",
"[]>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.getSourcesHelper.$1",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignment",
"type": "Function",
"tags": [],
"label": "isAssignment",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignment.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignmentComplete",
"type": "Function",
"tags": [],
"label": "isAssignmentComplete",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined) => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isAssignmentComplete.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isColumnItem",
"type": "Function",
"tags": [],
"label": "isColumnItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isColumnItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isFunctionItem",
"type": "Function",
"tags": [],
"label": "isFunctionItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isFunctionItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isLiteralItem",
"type": "Function",
"tags": [],
"label": "isLiteralItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isLiteralItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isOptionItem",
"type": "Function",
"tags": [],
"label": "isOptionItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isOptionItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSingleItem",
"type": "Function",
"tags": [],
"label": "isSingleItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSingleItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSourceItem",
"type": "Function",
"tags": [],
"label": "isSourceItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSourceItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction",
"type": "Function",
"tags": [],
"label": "isSupportedFunction",
"description": [],
"signature": [
"(name: string, parentCommand: string | undefined, option: string | undefined) => { supported: boolean; reason: ",
"ReasonTypes",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$2",
"type": "string",
"tags": [],
"label": "parentCommand",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isSupportedFunction.$3",
"type": "string",
"tags": [],
"label": "option",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isTimeIntervalItem",
"type": "Function",
"tags": [],
"label": "isTimeIntervalItem",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.isTimeIntervalItem.$1",
"type": "CompoundType",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.printFunctionSignature",
"type": "Function",
"tags": [],
"label": "printFunctionSignature",
"description": [],
"signature": [
"(arg: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.printFunctionSignature.$1",
"type": "Object",
"tags": [],
"label": "arg",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText",
"type": "Function",
"tags": [],
"label": "shouldBeQuotedText",
"description": [],
"signature": [
"(text: string, { dashSupported }: { dashSupported?: boolean | undefined; }) => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$2",
"type": "Object",
"tags": [],
"label": "{ dashSupported }",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.shouldBeQuotedText.$2.dashSupported",
"type": "CompoundType",
"tags": [],
"label": "dashSupported",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest",
"type": "Function",
"tags": [],
"label": "suggest",
"description": [],
"signature": [
"(fullText: string, offset: number, context: ",
"EditorContext",
", resourceRetriever: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.SuggestionRawDefinition",
"text": "SuggestionRawDefinition"
},
"[]>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$1",
"type": "string",
"tags": [],
"label": "fullText",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$2",
"type": "number",
"tags": [],
"label": "offset",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$3",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"EditorContext"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.suggest.$4",
"type": "Object",
"tags": [],
"label": "resourceRetriever",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery",
"type": "Function",
"tags": [],
"label": "validateQuery",
"description": [
"\nES|QL validation public API\nIt takes a query string and returns a list of messages (errors and warnings) after validate\nThe astProvider is optional, but if not provided the default one from '@kbn/esql-validation-autocomplete' will be used.\nThis is useful for async loading the ES|QL parser and reduce the bundle size, or to swap grammar version.\nAs for the callbacks, while optional, the validation function will selectively ignore some errors types based on each callback missing."
],
"signature": [
"(queryString: string, options: ",
"ValidationOptions",
", callbacks: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined) => Promise<",
"ValidationResult",
">"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$1",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ValidationOptions"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.validateQuery.$3",
"type": "Object",
"tags": [],
"label": "callbacks",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLCallbacks",
"text": "ESQLCallbacks"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition",
"type": "Interface",
"tags": [],
"label": "CommandDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.CommandDefinition",
"text": "CommandDefinition"
},
"<CommandName>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.name",
"type": "Uncategorized",
"tags": [],
"label": "name",
"description": [],
"signature": [
"CommandName"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nA description of what the command does. Displayed in the autocomplete."
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.declaration",
"type": "string",
"tags": [],
"label": "declaration",
"description": [
"\nThe pattern for declaring this command statement. Displayed in the autocomplete."
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.examples",
"type": "Array",
"tags": [],
"label": "examples",
"description": [
"\nA list of examples of how to use the command. Displayed in the autocomplete."
],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [
"\nCommand name prefix, such as \"LEFT\" or \"RIGHT\" for JOIN command."
],
"signature": [
"CommandTypeDefinition",
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.preview",
"type": "CompoundType",
"tags": [],
"label": "preview",
"description": [
"\nDisplays a Technical preview label in the autocomplete"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.hidden",
"type": "CompoundType",
"tags": [],
"label": "hidden",
"description": [
"\nWhether to show or hide in autocomplete suggestion list. We generally use\nthis for commands that are not yet ready to be advertised."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [
"\nThis method is run when the command is being validated, but it does not\nprevent the default behavior. If you need a full override, we are currently\ndoing those directly in the validateCommand function in the validation module."
],
"signature": [
"((command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<CommandName>, references: ",
"ReferenceMaps",
", ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
"[]) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate.$1",
"type": "Object",
"tags": [],
"label": "command",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<CommandName>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate.$2",
"type": "Object",
"tags": [],
"label": "references",
"description": [],
"signature": [
"ReferenceMaps"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.validate.$3",
"type": "Array",
"tags": [],
"label": "ast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.suggest",
"type": "Function",
"tags": [],
"label": "suggest",
"description": [
"\nThis method is called to load suggestions when the cursor is within this command."
],
"signature": [
"(params: ",
"CommandSuggestParams",
"<CommandName>) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.SuggestionRawDefinition",
"text": "SuggestionRawDefinition"
},
"[] | Promise<",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.SuggestionRawDefinition",
"text": "SuggestionRawDefinition"
},
"[]>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.suggest.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"CommandSuggestParams",
"<CommandName>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.fieldsSuggestionsAfter",
"type": "Function",
"tags": [],
"label": "fieldsSuggestionsAfter",
"description": [
"\nThis method is called to define the fields available after this command is applied."
],
"signature": [
"((lastCommand: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
", previousCommandFields: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[], userDefinedColumns: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[]) => ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[]) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.fieldsSuggestionsAfter.$1",
"type": "CompoundType",
"tags": [],
"label": "lastCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.fieldsSuggestionsAfter.$2",
"type": "Array",
"tags": [],
"label": "previousCommandFields",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.CommandDefinition.fieldsSuggestionsAfter.$3",
"type": "Array",
"tags": [],
"label": "userDefinedColumns",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks",
"type": "Interface",
"tags": [],
"label": "ESQLCallbacks",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getSources",
"type": "Function",
"tags": [],
"label": "getSources",
"description": [],
"signature": [
"CallbackFn<{}, ",
"ESQLSourceResult",
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getColumnsFor",
"type": "Function",
"tags": [],
"label": "getColumnsFor",
"description": [],
"signature": [
"CallbackFn<{ query: string; }, ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLFieldWithMetadata",
"text": "ESQLFieldWithMetadata"
},
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getPolicies",
"type": "Function",
"tags": [],
"label": "getPolicies",
"description": [],
"signature": [
"CallbackFn<{}, { name: string; sourceIndices: string[]; matchField: string; enrichFields: string[]; }> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getPreferences",
"type": "Function",
"tags": [],
"label": "getPreferences",
"description": [],
"signature": [
"(() => Promise<{ histogramBarTarget: number; }>) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getFieldsMetadata",
"type": "Object",
"tags": [],
"label": "getFieldsMetadata",
"description": [],
"signature": [
"Promise<",
"PartialFieldsMetadataClient",
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getVariables",
"type": "Function",
"tags": [],
"label": "getVariables",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "@kbn/esql-types",
"scope": "common",
"docId": "kibKbnEsqlTypesPluginApi",
"section": "def-common.ESQLControlVariable",
"text": "ESQLControlVariable"
},
"[] | undefined) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.canSuggestVariables",
"type": "Function",
"tags": [],
"label": "canSuggestVariables",
"description": [],
"signature": [
"(() => boolean) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getJoinIndices",
"type": "Function",
"tags": [],
"label": "getJoinIndices",
"description": [],
"signature": [
"(() => Promise<{ indices: ",
{
"pluginId": "@kbn/esql-types",
"scope": "common",
"docId": "kibKbnEsqlTypesPluginApi",
"section": "def-common.IndexAutocompleteItem",
"text": "IndexAutocompleteItem"
},
"[]; }>) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLCallbacks.getTimeseriesIndices",
"type": "Function",
"tags": [],
"label": "getTimeseriesIndices",
"description": [],
"signature": [
"(() => Promise<{ indices: ",
{
"pluginId": "@kbn/esql-types",
"scope": "common",
"docId": "kibKbnEsqlTypesPluginApi",
"section": "def-common.IndexAutocompleteItem",
"text": "IndexAutocompleteItem"
},
"[]; }>) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata",
"type": "Interface",
"tags": [],
"label": "ESQLFieldWithMetadata",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"keyword\" | \"text\" | \"date\" | \"date_nanos\" | \"version\" | \"integer\" | \"long\" | \"double\" | \"unsigned_long\" | \"unsupported\" | \"cartesian_point\" | \"cartesian_shape\" | \"counter_integer\" | \"counter_long\" | \"counter_double\" | \"function_named_parameters\""
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata.isEcs",
"type": "CompoundType",
"tags": [],
"label": "isEcs",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata.hasConflict",
"type": "CompoundType",
"tags": [],
"label": "hasConflict",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLFieldWithMetadata.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ description?: string | undefined; } | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy",
"type": "Interface",
"tags": [],
"label": "ESQLPolicy",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.sourceIndices",
"type": "Array",
"tags": [],
"label": "sourceIndices",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.matchField",
"type": "string",
"tags": [],
"label": "matchField",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLPolicy.enrichFields",
"type": "Array",
"tags": [],
"label": "enrichFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLUserDefinedColumn",
"type": "Interface",
"tags": [],
"label": "ESQLUserDefinedColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLUserDefinedColumn.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLUserDefinedColumn.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"unknown\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"keyword\" | \"text\" | \"date\" | \"date_nanos\" | \"version\" | \"integer\" | \"long\" | \"double\" | \"unsigned_long\" | \"unsupported\" | \"null\" | \"cartesian_point\" | \"cartesian_shape\" | \"date_period\" | \"time_duration\" | \"counter_integer\" | \"counter_long\" | \"counter_double\" | \"function_named_parameters\" | \"time_literal\""
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ESQLUserDefinedColumn.location",
"type": "Object",
"tags": [],
"label": "location",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition",
"type": "Interface",
"tags": [],
"label": "FunctionDefinition",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
"FunctionDefinitionTypes"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.preview",
"type": "CompoundType",
"tags": [],
"label": "preview",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.ignoreAsSuggestion",
"type": "CompoundType",
"tags": [],
"label": "ignoreAsSuggestion",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.alias",
"type": "Array",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.locationsAvailable",
"type": "Array",
"tags": [],
"label": "locationsAvailable",
"description": [],
"signature": [
"Location",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.signatures",
"type": "Array",
"tags": [],
"label": "signatures",
"description": [],
"signature": [
"Signature",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.examples",
"type": "Array",
"tags": [],
"label": "examples",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [],
"signature": [
"((fnDef: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLMessage",
"text": "ESQLMessage"
},
"[]) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.validate.$1",
"type": "Object",
"tags": [],
"label": "fnDef",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.operator",
"type": "string",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.customParametersSnippet",
"type": "string",
"tags": [],
"label": "customParametersSnippet",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.FunctionDefinition.license",
"type": "string",
"tags": [],
"label": "license",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals",
"type": "Interface",
"tags": [],
"label": "Literals",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.Literals.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition",
"type": "Interface",
"tags": [],
"label": "SuggestionRawDefinition",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.filterText",
"type": "string",
"tags": [],
"label": "filterText",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.asSnippet",
"type": "CompoundType",
"tags": [],
"label": "asSnippet",
"description": [
"\nShould the text be inserted as a snippet?\nThat is usually used for special behaviour like moving the cursor in a specific position\nafter inserting the text.\ni.e. 'fnName( $0 )' will insert fnName( ) and move the cursor where $0 is."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [
"\nThis is useful to identify the suggestion type and apply different styles to it."
],
"signature": [
"\"Value\" | \"Text\" | \"Field\" | \"Function\" | \"Operator\" | \"Method\" | \"Variable\" | \"Class\" | \"Constant\" | \"Keyword\" | \"Reference\" | \"Snippet\" | \"Issue\""
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.detail",
"type": "string",
"tags": [],
"label": "detail",
"description": [
"\nA very short description for the suggestion entry that can be shown on the UI next to the label"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.documentation",
"type": "Object",
"tags": [],
"label": "documentation",
"description": [
"\nA longer description for the suggestion entry that can be shown on demand on the UI."
],
"signature": [
"{ value: string; } | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.sortText",
"type": "string",
"tags": [],
"label": "sortText",
"description": [
"\nA string to use for sorting the suggestion within the suggestions list"
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.command",
"type": "Object",
"tags": [],
"label": "command",
"description": [
"\nSuggestions can trigger a command by id. This is useful to trigger specific actions in some contexts"
],
"signature": [
"{ title: string; id: string; } | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.SuggestionRawDefinition.rangeToReplace",
"type": "Object",
"tags": [],
"label": "rangeToReplace",
"description": [
"\nThe range that should be replaced when the suggestion is applied\n\nIMPORTANT NOTE!!!\n\nThis range is ZERO-based and NOT end-inclusive — [start, end)\nAlso, do NOT try to account for newline characters. This is taken care of later."
],
"signature": [
"{ start: number; end: number; } | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors",
"type": "Interface",
"tags": [],
"label": "ValidationErrors",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentType",
"type": "Object",
"tags": [],
"label": "wrongArgumentType",
"description": [],
"signature": [
"{ message: string; type: { name: string; argType: string; value: string | number | Date; givenType: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumber",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumber",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumberTooMany",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumberTooMany",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; extraArgs: number; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongArgumentNumberTooFew",
"type": "Object",
"tags": [],
"label": "wrongArgumentNumberTooFew",
"description": [],
"signature": [
"{ message: string; type: { fn: string; numArgs: number; passedArgs: number; missingArgs: number; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownColumn",
"type": "Object",
"tags": [],
"label": "unknownColumn",
"description": [],
"signature": [
"{ message: string; type: { name: string | number; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownFunction",
"type": "Object",
"tags": [],
"label": "unknownFunction",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownIndex",
"type": "Object",
"tags": [],
"label": "unknownIndex",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noNestedArgumentSupport",
"type": "Object",
"tags": [],
"label": "noNestedArgumentSupport",
"description": [],
"signature": [
"{ message: string; type: { name: string; argType: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFunctionForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedFunctionForCommand",
"description": [],
"signature": [
"{ message: string; type: { name: string; command: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFunctionForCommandOption",
"type": "Object",
"tags": [],
"label": "unsupportedFunctionForCommandOption",
"description": [],
"signature": [
"{ message: string; type: { name: string; command: string; option: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedLiteralOption",
"type": "Object",
"tags": [],
"label": "unsupportedLiteralOption",
"description": [],
"signature": [
"{ message: string; type: { name: string; value: string; supportedOptions: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.shadowFieldType",
"type": "Object",
"tags": [],
"label": "shadowFieldType",
"description": [],
"signature": [
"{ message: string; type: { field: string; fieldType: string; newType: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedColumnTypeForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedColumnTypeForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; type: string; givenType: string; column: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownDissectKeyword",
"type": "Object",
"tags": [],
"label": "unknownDissectKeyword",
"description": [],
"signature": [
"{ message: string; type: { keyword: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongOptionArgumentType",
"type": "Object",
"tags": [],
"label": "wrongOptionArgumentType",
"description": [],
"signature": [
"{ message: string; type: { command: string; option: string; type: string; givenValue: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownInterval",
"type": "Object",
"tags": [],
"label": "unknownInterval",
"description": [],
"signature": [
"{ message: string; type: { value: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedTypeForCommand",
"type": "Object",
"tags": [],
"label": "unsupportedTypeForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; type: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownPolicy",
"type": "Object",
"tags": [],
"label": "unknownPolicy",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownAggregateFunction",
"type": "Object",
"tags": [],
"label": "unknownAggregateFunction",
"description": [],
"signature": [
"{ message: string; type: { type: string; value: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wildcardNotSupportedForCommand",
"type": "Object",
"tags": [],
"label": "wildcardNotSupportedForCommand",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noWildcardSupportAsArg",
"type": "Object",
"tags": [],
"label": "noWildcardSupportAsArg",
"description": [],
"signature": [
"{ message: string; type: { name: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedFieldType",
"type": "Object",
"tags": [],
"label": "unsupportedFieldType",
"description": [],
"signature": [
"{ message: string; type: { field: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unsupportedMode",
"type": "Object",
"tags": [],
"label": "unsupportedMode",
"description": [],
"signature": [
"{ message: string; type: { command: string; value: string; expected: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.fnUnsupportedAfterCommand",
"type": "Object",
"tags": [],
"label": "fnUnsupportedAfterCommand",
"description": [],
"signature": [
"{ message: string; type: { function: string; command: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.expectedConstant",
"type": "Object",
"tags": [],
"label": "expectedConstant",
"description": [],
"signature": [
"{ message: string; type: { fn: string; given: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.metadataBracketsDeprecation",
"type": "Object",
"tags": [],
"label": "metadataBracketsDeprecation",
"description": [],
"signature": [
"{ message: string; type: {}; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.unknownMetadataField",
"type": "Object",
"tags": [],
"label": "unknownMetadataField",
"description": [],
"signature": [
"{ message: string; type: { value: string; availableFields: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.wrongDissectOptionArgumentType",
"type": "Object",
"tags": [],
"label": "wrongDissectOptionArgumentType",
"description": [],
"signature": [
"{ message: string; type: { value: string | number; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.noAggFunction",
"type": "Object",
"tags": [],
"label": "noAggFunction",
"description": [],
"signature": [
"{ message: string; type: { commandName: string; expression: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.expressionNotAggClosed",
"type": "Object",
"tags": [],
"label": "expressionNotAggClosed",
"description": [],
"signature": [
"{ message: string; type: { commandName: string; expression: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.aggInAggFunction",
"type": "Object",
"tags": [],
"label": "aggInAggFunction",
"description": [],
"signature": [
"{ message: string; type: { nestedAgg: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.onlyWhereCommandSupported",
"type": "Object",
"tags": [],
"label": "onlyWhereCommandSupported",
"description": [],
"signature": [
"{ message: string; type: { fn: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.invalidJoinIndex",
"type": "Object",
"tags": [],
"label": "invalidJoinIndex",
"description": [],
"signature": [
"{ message: string; type: { identifier: string; }; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ValidationErrors.tooManyForks",
"type": "Object",
"tags": [],
"label": "tooManyForks",
"description": [],
"signature": [
"{ message: string; type: {}; }"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.aggFunctionDefinitions",
"type": "Array",
"tags": [],
"label": "aggFunctionDefinitions",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.FunctionDefinition",
"text": "FunctionDefinition"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/generated/aggregation_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ErrorTypes",
"type": "Type",
"tags": [],
"label": "ErrorTypes",
"description": [],
"signature": [
"keyof ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ValidationErrors",
"text": "ValidationErrors"
}
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.esqlFunctionNames",
"type": "Array",
"tags": [
"note"
],
"label": "esqlFunctionNames",
"description": [
"\n__AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.__\n"
],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/generated/function_names.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.ItemKind",
"type": "Type",
"tags": [],
"label": "ItemKind",
"description": [],
"signature": [
"\"Value\" | \"Text\" | \"Field\" | \"Function\" | \"Operator\" | \"Method\" | \"Variable\" | \"Class\" | \"Constant\" | \"Keyword\" | \"Reference\" | \"Snippet\" | \"Issue\""
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-validation-autocomplete",
"id": "def-common.timeUnits",
"type": "Array",
"tags": [],
"label": "timeUnits",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/definitions/literals.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink