3abb79a179
* Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <github@gidi.io> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <lcawley@elastic.co> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <github@gidi.io> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
6800 lines
No EOL
221 KiB
JSON
6800 lines
No EOL
221 KiB
JSON
{
|
|
"id": "data.indexPatterns",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPatternsFetcher",
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "elasticsearchClient",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 39
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "allowNoIndices",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 39
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 39
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard",
|
|
"type": "Function",
|
|
"label": "getFieldsForWildcard",
|
|
"signature": [
|
|
"(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.FieldDescriptor",
|
|
"text": "FieldDescriptor"
|
|
},
|
|
"[]>"
|
|
],
|
|
"description": [
|
|
"\n Get a list of field objects for an index pattern that may contain wildcards\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options",
|
|
"type": "Object",
|
|
"label": "options",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.pattern",
|
|
"type": "CompoundType",
|
|
"label": "pattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"signature": [
|
|
"string | string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.metaFields",
|
|
"type": "Array",
|
|
"label": "metaFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.fieldCapsOptions",
|
|
"type": "Object",
|
|
"label": "fieldCapsOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"signature": [
|
|
"{ allow_no_indices: boolean; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.options.rollupIndex",
|
|
"type": "string",
|
|
"label": "rollupIndex",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 53
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"property",
|
|
"return"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 53
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern",
|
|
"type": "Function",
|
|
"label": "getFieldsForTimePattern",
|
|
"signature": [
|
|
"(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.FieldDescriptor",
|
|
"text": "FieldDescriptor"
|
|
},
|
|
"[]>"
|
|
],
|
|
"description": [
|
|
"\n Get a list of field objects for a time pattern\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options",
|
|
"type": "Object",
|
|
"label": "options",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.pattern",
|
|
"type": "string",
|
|
"label": "pattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 116
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.metaFields",
|
|
"type": "Array",
|
|
"label": "metaFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 117
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.lookBack",
|
|
"type": "number",
|
|
"label": "lookBack",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 118
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.interval",
|
|
"type": "string",
|
|
"label": "interval",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 119
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 115
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"property",
|
|
"return"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 115
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IndexPatternsFetcher.validatePatternListActive",
|
|
"type": "Function",
|
|
"label": "validatePatternListActive",
|
|
"signature": [
|
|
"(patternList: string[]) => Promise<string[]>"
|
|
],
|
|
"description": [
|
|
"\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Array",
|
|
"label": "patternList",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"description": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 136
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 136
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.IndexPatternsServiceProvider",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPatternsServiceProvider",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.IndexPatternsServiceProvider",
|
|
"text": "IndexPatternsServiceProvider"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<void, ",
|
|
"IndexPatternsServiceStart",
|
|
", object, object>"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.IndexPatternsServiceProvider.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStartDependencies",
|
|
"text": "DataPluginStartDependencies"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
},
|
|
">, { expressions }: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.IndexPatternsServiceSetupDeps",
|
|
"text": "IndexPatternsServiceSetupDeps"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStartDependencies",
|
|
"text": "DataPluginStartDependencies"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-server.DataPluginStart",
|
|
"text": "DataPluginStart"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 47
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "{ expressions }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.IndexPatternsServiceSetupDeps",
|
|
"text": "IndexPatternsServiceSetupDeps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 48
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 46
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.IndexPatternsServiceProvider.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", { fieldFormats, logger }: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.IndexPatternsServiceStartDeps",
|
|
"text": "IndexPatternsServiceStartDeps"
|
|
},
|
|
") => { indexPatternsServiceFactory: (savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, elasticsearchClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 58
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "{ fieldFormats, logger }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.IndexPatternsServiceStartDeps",
|
|
"text": "IndexPatternsServiceStartDeps"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 58
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 58
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.getCapabilitiesForRollupIndices",
|
|
"type": "Function",
|
|
"label": "getCapabilitiesForRollupIndices",
|
|
"signature": [
|
|
"(indices: { [key: string]: any; }) => { [key: string]: any; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.getCapabilitiesForRollupIndices.indices",
|
|
"type": "Object",
|
|
"label": "indices",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.getCapabilitiesForRollupIndices.indices.Unnamed",
|
|
"type": "Any",
|
|
"label": "Unnamed",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts",
|
|
"lineNumber": 11
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.mergeCapabilitiesWithFields",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities",
|
|
"type": "Object",
|
|
"label": "rollupIndexCapabilities",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities.Unnamed",
|
|
"type": "Any",
|
|
"label": "Unnamed",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 14
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi",
|
|
"type": "Object",
|
|
"label": "fieldsFromFieldCapsApi",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi.Unnamed",
|
|
"type": "Any",
|
|
"label": "Unnamed",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 15
|
|
}
|
|
},
|
|
{
|
|
"type": "Array",
|
|
"label": "previousFields",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.FieldDescriptor",
|
|
"text": "FieldDescriptor"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 16
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: { [key: string]: any; }, previousFields?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.FieldDescriptor",
|
|
"text": "FieldDescriptor"
|
|
},
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-server.FieldDescriptor",
|
|
"text": "FieldDescriptor"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"label": "mergeCapabilitiesWithFields",
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.shouldReadFieldFromDocValues",
|
|
"type": "Function",
|
|
"label": "shouldReadFieldFromDocValues",
|
|
"signature": [
|
|
"(aggregatable: boolean, esType: string) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
|
|
"lineNumber": 9
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "esType",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
|
|
"lineNumber": 9
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.FieldDescriptor",
|
|
"type": "Interface",
|
|
"label": "FieldDescriptor",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.aggregatable",
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.readFromDocValues",
|
|
"type": "boolean",
|
|
"label": "readFromDocValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.searchable",
|
|
"type": "boolean",
|
|
"label": "searchable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 25
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"FieldSubType | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.FieldDescriptor",
|
|
"type": "Interface",
|
|
"label": "FieldDescriptor",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.aggregatable",
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.readFromDocValues",
|
|
"type": "boolean",
|
|
"label": "readFromDocValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.searchable",
|
|
"type": "boolean",
|
|
"label": "searchable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 25
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.FieldDescriptor.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"FieldSubType | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"id": "def-common.DuplicateIndexPatternError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DuplicateIndexPatternError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.DuplicateIndexPatternError",
|
|
"text": "DuplicateIndexPatternError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-common.DuplicateIndexPatternError.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "message",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
|
|
"lineNumber": 10
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
|
|
"lineNumber": 10
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 46
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.fieldFormatMap",
|
|
"type": "Object",
|
|
"label": "fieldFormatMap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"signature": [
|
|
"Record<string, any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.typeMeta",
|
|
"type": "Object",
|
|
"label": "typeMeta",
|
|
"description": [
|
|
"\nOnly used by rollup indices, used by rollup specific endpoint to load field list"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.TypeMeta",
|
|
"text": "TypeMeta"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.fields",
|
|
"type": "CompoundType",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPatternFieldList",
|
|
"text": "IIndexPatternFieldList"
|
|
},
|
|
" & { toSpec: () => Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
">; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.timeFieldName",
|
|
"type": "string",
|
|
"label": "timeFieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"id": "def-common.IndexPattern.intervalName",
|
|
"type": "string",
|
|
"label": "intervalName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [
|
|
"\nType is used to identify rollup index patterns"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.formatHit",
|
|
"type": "Function",
|
|
"label": "formatHit",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"signature": [
|
|
"{ (hit: Record<string, any>, type?: string | undefined): any; formatField: FormatFieldFn; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.formatField",
|
|
"type": "Function",
|
|
"label": "formatField",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 67
|
|
},
|
|
"signature": [
|
|
"FormatFieldFn"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.flattenHit",
|
|
"type": "Function",
|
|
"label": "flattenHit",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 68
|
|
},
|
|
"signature": [
|
|
"(hit: Record<string, any>, deep?: boolean | undefined) => Record<string, any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.metaFields",
|
|
"type": "Array",
|
|
"label": "metaFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 69
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.version",
|
|
"type": "string",
|
|
"label": "version",
|
|
"description": [
|
|
"\nSavedObject version"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 73
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.sourceFilters",
|
|
"type": "Array",
|
|
"label": "sourceFilters",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.SourceFilter",
|
|
"text": "SourceFilter"
|
|
},
|
|
"[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPattern.allowNoIndex",
|
|
"type": "boolean",
|
|
"label": "allowNoIndex",
|
|
"description": [
|
|
"\nprevents errors when index pattern exists before indices"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 84
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"IndexPatternDeps"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 86
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 86
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getOriginalSavedObjectBody",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"
|
|
],
|
|
"description": [
|
|
"\nGet last saved saved object fields"
|
|
],
|
|
"label": "getOriginalSavedObjectBody",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 128
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.resetOriginalSavedObjectBody",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [
|
|
"\nReset last saved saved object fields. used after saving"
|
|
],
|
|
"label": "resetOriginalSavedObjectBody",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 133
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getFieldAttrs",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => { [x: string]: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrSet",
|
|
"text": "FieldAttrSet"
|
|
},
|
|
"; }"
|
|
],
|
|
"description": [],
|
|
"label": "getFieldAttrs",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 137
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getComputedFields",
|
|
"type": "Function",
|
|
"label": "getComputedFields",
|
|
"signature": [
|
|
"() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
">; }"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 162
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.toSpec",
|
|
"type": "Function",
|
|
"label": "toSpec",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
],
|
|
"description": [
|
|
"\nCreate static representation of index pattern"
|
|
],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 208
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getSourceFiltering",
|
|
"type": "Function",
|
|
"label": "getSourceFiltering",
|
|
"signature": [
|
|
"() => { excludes: any[]; }"
|
|
],
|
|
"description": [
|
|
"\nGet the source filtering configuration for that index."
|
|
],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 230
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.addScriptedField",
|
|
"type": "Function",
|
|
"label": "addScriptedField",
|
|
"signature": [
|
|
"(name: string, script: string, fieldType?: string) => Promise<void>"
|
|
],
|
|
"description": [
|
|
"\nAdd scripted field to field list\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "name",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
"field name"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 244
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "script",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
"script code"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 244
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "fieldType",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 244
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 244
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.removeScriptedField",
|
|
"type": "Function",
|
|
"label": "removeScriptedField",
|
|
"signature": [
|
|
"(fieldName: string) => void"
|
|
],
|
|
"description": [
|
|
"\nRemove scripted field from field list"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 270
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 270
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getNonScriptedFields",
|
|
"type": "Function",
|
|
"label": "getNonScriptedFields",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 277
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getScriptedFields",
|
|
"type": "Function",
|
|
"label": "getScriptedFields",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 281
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.isTimeBased",
|
|
"type": "Function",
|
|
"label": "isTimeBased",
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 285
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.isTimeNanosBased",
|
|
"type": "Function",
|
|
"label": "isTimeNanosBased",
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 289
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getTimeField",
|
|
"type": "Function",
|
|
"label": "getTimeField",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 294
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getFieldByName",
|
|
"type": "Function",
|
|
"label": "getFieldByName",
|
|
"signature": [
|
|
"(name: string) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "name",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 299
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 299
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getAggregationRestrictions",
|
|
"type": "Function",
|
|
"label": "getAggregationRestrictions",
|
|
"signature": [
|
|
"() => Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 304
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getAsSavedObjectBody",
|
|
"type": "Function",
|
|
"label": "getAsSavedObjectBody",
|
|
"signature": [
|
|
"() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"
|
|
],
|
|
"description": [
|
|
"\nReturns index pattern as saved object body for saving"
|
|
],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 311
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getFormatterForField",
|
|
"type": "Function",
|
|
"label": "getFormatterForField",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"description": [
|
|
"\nProvide a field, get its formatter"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 340
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 339
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.addRuntimeField",
|
|
"type": "Function",
|
|
"label": "addRuntimeField",
|
|
"signature": [
|
|
"(name: string, runtimeField: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [
|
|
"\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "name",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
"Field name"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 360
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "runtimeField",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
}
|
|
],
|
|
"description": [
|
|
"Runtime field definition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 360
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 360
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.removeRuntimeField",
|
|
"type": "Function",
|
|
"label": "removeRuntimeField",
|
|
"signature": [
|
|
"(name: string) => void"
|
|
],
|
|
"description": [
|
|
"\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "name",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
"Field name"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 384
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 384
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.getFormatterForFieldNoDefault",
|
|
"type": "Function",
|
|
"label": "getFormatterForFieldNoDefault",
|
|
"signature": [
|
|
"(fieldname: string) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [
|
|
"\nGet formatter for a given field name. Return undefined if none exists"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldname",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 404
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 404
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.setFieldAttrs",
|
|
"type": "Function",
|
|
"label": "setFieldAttrs",
|
|
"signature": [
|
|
"<K extends \"customLabel\" | \"count\">(fieldName: string, attrName: K, value: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrSet",
|
|
"text": "FieldAttrSet"
|
|
},
|
|
"[K]) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 412
|
|
}
|
|
},
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "attrName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"K"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 413
|
|
}
|
|
},
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "value",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrSet",
|
|
"text": "FieldAttrSet"
|
|
},
|
|
"[K]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 414
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 411
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.setFieldCustomLabel",
|
|
"type": "Function",
|
|
"label": "setFieldCustomLabel",
|
|
"signature": [
|
|
"(fieldName: string, customLabel: string | null | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 422
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "customLabel",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 422
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 422
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.setFieldCount",
|
|
"type": "Function",
|
|
"label": "setFieldCount",
|
|
"signature": [
|
|
"(fieldName: string, count: number | null | undefined) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 433
|
|
}
|
|
},
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "count",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 433
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 433
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.setFieldFormat",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 446
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "format",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 446
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(fieldName: string, format: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>) => void"
|
|
],
|
|
"description": [],
|
|
"label": "setFieldFormat",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 446
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPattern.deleteFieldFormat",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 450
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(fieldName: string) => void"
|
|
],
|
|
"description": [],
|
|
"label": "deleteFieldFormat",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 450
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPatternField",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternField.spec",
|
|
"type": "Object",
|
|
"label": "spec",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "spec",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 21
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"tags": [],
|
|
"description": [
|
|
"\nCount is used for field popularity"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 31
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 35
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.runtimeField",
|
|
"type": "Object",
|
|
"label": "runtimeField",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.runtimeField",
|
|
"type": "Object",
|
|
"label": "runtimeField",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.script",
|
|
"type": "string",
|
|
"label": "script",
|
|
"tags": [],
|
|
"description": [
|
|
"\nScript field code"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.script",
|
|
"type": "string",
|
|
"label": "script",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.lang",
|
|
"type": "string",
|
|
"label": "lang",
|
|
"tags": [],
|
|
"description": [
|
|
"\nScript field language"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.lang",
|
|
"type": "string",
|
|
"label": "lang",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.customLabel",
|
|
"type": "string",
|
|
"label": "customLabel",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 69
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.customLabel",
|
|
"type": "string",
|
|
"label": "customLabel",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 73
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.conflictDescriptions",
|
|
"type": "Object",
|
|
"label": "conflictDescriptions",
|
|
"tags": [],
|
|
"description": [
|
|
"\nDescription of field type conflicts across different indices in the same index pattern"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"signature": [
|
|
"Record<string, string[]> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.conflictDescriptions",
|
|
"type": "Object",
|
|
"label": "conflictDescriptions",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"signature": [
|
|
"Record<string, string[]> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 89
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.displayName",
|
|
"type": "string",
|
|
"label": "displayName",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 93
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 101
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 107
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.scripted",
|
|
"type": "boolean",
|
|
"label": "scripted",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 111
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.searchable",
|
|
"type": "boolean",
|
|
"label": "searchable",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 115
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.aggregatable",
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 119
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.readFromDocValues",
|
|
"type": "boolean",
|
|
"label": "readFromDocValues",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 123
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 127
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldSubType",
|
|
"text": "IFieldSubType"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.isMapped",
|
|
"type": "CompoundType",
|
|
"label": "isMapped",
|
|
"tags": [],
|
|
"description": [
|
|
"\nIs the field part of the index mapping?"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 134
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.sortable",
|
|
"type": "boolean",
|
|
"label": "sortable",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 139
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.filterable",
|
|
"type": "boolean",
|
|
"label": "filterable",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 146
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.visualizable",
|
|
"type": "boolean",
|
|
"label": "visualizable",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 154
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.deleteCount",
|
|
"type": "Function",
|
|
"label": "deleteCount",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 159
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.toJSON",
|
|
"type": "Function",
|
|
"label": "toJSON",
|
|
"signature": [
|
|
"() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record<string, string[]> | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldSubType",
|
|
"text": "IFieldSubType"
|
|
},
|
|
" | undefined; customLabel: string | undefined; }"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 163
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternField.toSpec",
|
|
"type": "Function",
|
|
"label": "toSpec",
|
|
"signature": [
|
|
"({ getFormatterForField, }?: { getFormatterForField?: ((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined; }) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }",
|
|
"type": "Object",
|
|
"label": "{\n getFormatterForField,\n }",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField",
|
|
"type": "Function",
|
|
"label": "getFormatterForField",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 184
|
|
},
|
|
"signature": [
|
|
"((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 183
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 181
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IndexPatternsService",
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternsService.ensureDefaultIndexPattern",
|
|
"type": "Function",
|
|
"label": "ensureDefaultIndexPattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 67
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.EnsureDefaultIndexPattern",
|
|
"text": "EnsureDefaultIndexPattern"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"IndexPatternsServiceDeps"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 69
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 69
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getIds",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "boolean",
|
|
"label": "refresh",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 108
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(refresh?: boolean) => Promise<string[]>"
|
|
],
|
|
"description": [
|
|
"\nGet list of index pattern ids"
|
|
],
|
|
"label": "getIds",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 108
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getTitles",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "boolean",
|
|
"label": "refresh",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 122
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(refresh?: boolean) => Promise<string[]>"
|
|
],
|
|
"description": [
|
|
"\nGet list of index pattern titles"
|
|
],
|
|
"label": "getTitles",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 122
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.find",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "search",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 138
|
|
}
|
|
},
|
|
{
|
|
"type": "number",
|
|
"label": "size",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 138
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(search: string, size?: number) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[]>"
|
|
],
|
|
"description": [
|
|
"\nFind and load index patterns by title"
|
|
],
|
|
"label": "find",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 138
|
|
},
|
|
"tags": [],
|
|
"returnComment": [
|
|
"IndexPattern[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getIdsWithTitle",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "boolean",
|
|
"label": "refresh",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 157
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"
|
|
],
|
|
"description": [
|
|
"\nGet list of index pattern ids with titles"
|
|
],
|
|
"label": "getIdsWithTitle",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 156
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.clearCache",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": false,
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 175
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(id?: string | undefined) => void"
|
|
],
|
|
"description": [
|
|
"\nClear index pattern list cache"
|
|
],
|
|
"label": "clearCache",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 175
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getCache",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSavedObjectAttrs",
|
|
"text": "IndexPatternSavedObjectAttrs"
|
|
},
|
|
">[] | null | undefined>"
|
|
],
|
|
"description": [],
|
|
"label": "getCache",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 184
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getDefault",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | null>"
|
|
],
|
|
"description": [
|
|
"\nGet default index pattern"
|
|
],
|
|
"label": "getDefault",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 194
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.setDefault",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 208
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "force",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 208
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(id: string, force?: boolean) => Promise<void>"
|
|
],
|
|
"description": [
|
|
"\nOptionally set default index pattern, unless force = true"
|
|
],
|
|
"label": "setDefault",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 208
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getFieldsForWildcard",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 219
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
") => Promise<any>"
|
|
],
|
|
"description": [
|
|
"\nGet field list by providing { pattern }"
|
|
],
|
|
"label": "getFieldsForWildcard",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 219
|
|
},
|
|
"tags": [],
|
|
"returnComment": [
|
|
"FieldSpec[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.getFieldsForIndexPattern",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "CompoundType",
|
|
"label": "indexPattern",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 236
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": false,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 237
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
" | undefined) => Promise<any>"
|
|
],
|
|
"description": [
|
|
"\nGet field list by providing an index patttern (or spec)"
|
|
],
|
|
"label": "getFieldsForIndexPattern",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 235
|
|
},
|
|
"tags": [],
|
|
"returnComment": [
|
|
"FieldSpec[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.refreshFields",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 250
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"description": [
|
|
"\nRefresh field list for a given index pattern"
|
|
],
|
|
"label": "refreshFields",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 250
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.fieldArrayToMap",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Array",
|
|
"label": "fields",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 327
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "fieldAttrs",
|
|
"isRequired": false,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrs",
|
|
"text": "FieldAttrs"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 327
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(fields: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[], fieldAttrs?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrs",
|
|
"text": "FieldAttrs"
|
|
},
|
|
" | undefined) => Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nConverts field array to map"
|
|
],
|
|
"label": "fieldArrayToMap",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 327
|
|
},
|
|
"tags": [],
|
|
"returnComment": [
|
|
"Record<string, FieldSpec>"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.savedObjectToSpec",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "savedObject",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternAttributes",
|
|
"text": "IndexPatternAttributes"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 343
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(savedObject: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternAttributes",
|
|
"text": "IndexPatternAttributes"
|
|
},
|
|
">) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
],
|
|
"description": [
|
|
"\nConverts index pattern saved object to index pattern spec"
|
|
],
|
|
"label": "savedObjectToSpec",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 343
|
|
},
|
|
"tags": [],
|
|
"returnComment": [
|
|
"IndexPatternSpec"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.get",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 465
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(id: string) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nGet an index pattern by id. Cache optimized"
|
|
],
|
|
"label": "get",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 465
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.create",
|
|
"type": "Function",
|
|
"label": "create",
|
|
"signature": [
|
|
"(spec: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
},
|
|
", skipFetchFields?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nCreate a new index pattern instance"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "spec",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 484
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "skipFetchFields",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 484
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [
|
|
"IndexPattern"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 484
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.createAndSave",
|
|
"type": "Function",
|
|
"label": "createAndSave",
|
|
"signature": [
|
|
"(spec: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
},
|
|
", override?: boolean, skipFetchFields?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nCreate a new index pattern and save it right away"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "spec",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 509
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "override",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [
|
|
"Overwrite if existing index pattern exists."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 509
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "skipFetchFields",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [
|
|
"Whether to skip field refresh step."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 509
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 509
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.createSavedObject",
|
|
"type": "Function",
|
|
"label": "createSavedObject",
|
|
"signature": [
|
|
"(indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
", override?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nSave a new index pattern"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 522
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "override",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [
|
|
"Overwrite if existing index pattern exists"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 522
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 522
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.updateSavedObject",
|
|
"type": "Function",
|
|
"label": "updateSavedObject",
|
|
"signature": [
|
|
"(indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>"
|
|
],
|
|
"description": [
|
|
"\nSave existing index pattern. Will attempt to merge differences if there are conflicts"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 548
|
|
}
|
|
},
|
|
{
|
|
"type": "number",
|
|
"label": "saveAttempts",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 549
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "ignoreErrors",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 550
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 547
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsService.delete",
|
|
"type": "Function",
|
|
"label": "delete",
|
|
"signature": [
|
|
"(indexPatternId: string) => Promise<{}>"
|
|
],
|
|
"description": [
|
|
"\nDeletes an index pattern from .kibana index"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "indexPatternId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [
|
|
": Id of kibana Index Pattern to delete"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 633
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 633
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"id": "def-common.fieldList",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Array",
|
|
"label": "specs",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 35
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "shortDotsEnable",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 36
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(specs?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[], shortDotsEnable?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPatternFieldList",
|
|
"text": "IIndexPatternFieldList"
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "fieldList",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.getIndexPatternLoadMeta",
|
|
"type": "Function",
|
|
"children": [],
|
|
"signature": [
|
|
"() => Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternLoadExpressionFunctionDefinition",
|
|
"text": "IndexPatternLoadExpressionFunctionDefinition"
|
|
},
|
|
", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"disabled\" | \"help\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">"
|
|
],
|
|
"description": [],
|
|
"label": "getIndexPatternLoadMeta",
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.isFilterable",
|
|
"type": "Function",
|
|
"label": "isFilterable",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
|
|
"lineNumber": 14
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.isNestedField",
|
|
"type": "Function",
|
|
"label": "isNestedField",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
|
|
"lineNumber": 22
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.FieldAttrs",
|
|
"type": "Interface",
|
|
"label": "FieldAttrs",
|
|
"description": [],
|
|
"tags": [
|
|
"intenal"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-common.FieldAttrs.Unnamed",
|
|
"type": "Any",
|
|
"label": "Unnamed",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 75
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.FieldAttrSet",
|
|
"type": "Interface",
|
|
"label": "FieldAttrSet",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldAttrSet.customLabel",
|
|
"type": "string",
|
|
"label": "customLabel",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 79
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldAttrSet.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 78
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.FieldSpec",
|
|
"type": "Interface",
|
|
"label": "FieldSpec",
|
|
"description": [
|
|
"\nSerialized version of IndexPatternField"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"description": [
|
|
"\nPopularity count is used by discover"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 190
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.script",
|
|
"type": "string",
|
|
"label": "script",
|
|
"description": [
|
|
"\nScripted field painless script"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 194
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.lang",
|
|
"type": "string",
|
|
"label": "lang",
|
|
"description": [
|
|
"\nScripted field langauge\nPainless is the only valid scripted field language"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 199
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.conflictDescriptions",
|
|
"type": "Object",
|
|
"label": "conflictDescriptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 200
|
|
},
|
|
"signature": [
|
|
"Record<string, string[]> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.format",
|
|
"type": "Object",
|
|
"label": "format",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 201
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 202
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 203
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 204
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.scripted",
|
|
"type": "CompoundType",
|
|
"label": "scripted",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 205
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.searchable",
|
|
"type": "boolean",
|
|
"label": "searchable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 206
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.aggregatable",
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 207
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.readFromDocValues",
|
|
"type": "CompoundType",
|
|
"label": "readFromDocValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 208
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 209
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldSubType",
|
|
"text": "IFieldSubType"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.indexed",
|
|
"type": "CompoundType",
|
|
"label": "indexed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 210
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.customLabel",
|
|
"type": "string",
|
|
"label": "customLabel",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 211
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.runtimeField",
|
|
"type": "Object",
|
|
"label": "runtimeField",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 212
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.shortDotsEnable",
|
|
"type": "CompoundType",
|
|
"label": "shortDotsEnable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 214
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpec.isMapped",
|
|
"type": "CompoundType",
|
|
"label": "isMapped",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 215
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 186
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.FieldSpecExportFmt",
|
|
"type": "Interface",
|
|
"label": "FieldSpecExportFmt",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 167
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.script",
|
|
"type": "string",
|
|
"label": "script",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 168
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.lang",
|
|
"type": "string",
|
|
"label": "lang",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 169
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.conflictDescriptions",
|
|
"type": "Object",
|
|
"label": "conflictDescriptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 170
|
|
},
|
|
"signature": [
|
|
"Record<string, string[]> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 171
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.type",
|
|
"type": "Enum",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 172
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 173
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.scripted",
|
|
"type": "boolean",
|
|
"label": "scripted",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 174
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.searchable",
|
|
"type": "boolean",
|
|
"label": "searchable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 175
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.aggregatable",
|
|
"type": "boolean",
|
|
"label": "aggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 176
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.readFromDocValues",
|
|
"type": "CompoundType",
|
|
"label": "readFromDocValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 177
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 178
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldSubType",
|
|
"text": "IFieldSubType"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.format",
|
|
"type": "Object",
|
|
"label": "format",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 179
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.FieldSpecExportFmt.indexed",
|
|
"type": "CompoundType",
|
|
"label": "indexed",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 180
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 166
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.GetFieldsOptions",
|
|
"type": "Interface",
|
|
"label": "GetFieldsOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.pattern",
|
|
"type": "string",
|
|
"label": "pattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 119
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 120
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.lookBack",
|
|
"type": "CompoundType",
|
|
"label": "lookBack",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 121
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.metaFields",
|
|
"type": "Array",
|
|
"label": "metaFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 122
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.rollupIndex",
|
|
"type": "string",
|
|
"label": "rollupIndex",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 123
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptions.allowNoIndex",
|
|
"type": "CompoundType",
|
|
"label": "allowNoIndex",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 124
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 118
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.GetFieldsOptionsTimePattern",
|
|
"type": "Interface",
|
|
"label": "GetFieldsOptionsTimePattern",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptionsTimePattern.pattern",
|
|
"type": "string",
|
|
"label": "pattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 128
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptionsTimePattern.metaFields",
|
|
"type": "Array",
|
|
"label": "metaFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 129
|
|
},
|
|
"signature": [
|
|
"string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptionsTimePattern.lookBack",
|
|
"type": "number",
|
|
"label": "lookBack",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 130
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.GetFieldsOptionsTimePattern.interval",
|
|
"type": "string",
|
|
"label": "interval",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 131
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 127
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IFieldSubType",
|
|
"type": "Interface",
|
|
"label": "IFieldSubType",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldSubType.multi",
|
|
"type": "Object",
|
|
"label": "multi",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 154
|
|
},
|
|
"signature": [
|
|
"{ parent: string; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldSubType.nested",
|
|
"type": "Object",
|
|
"label": "nested",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 155
|
|
},
|
|
"signature": [
|
|
"{ path: string; } | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 153
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IFieldType",
|
|
"type": "Interface",
|
|
"label": "IFieldType",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 12
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 13
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.script",
|
|
"type": "string",
|
|
"label": "script",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.lang",
|
|
"type": "string",
|
|
"label": "lang",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.count",
|
|
"type": "number",
|
|
"label": "count",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.esTypes",
|
|
"type": "Array",
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.aggregatable",
|
|
"type": "CompoundType",
|
|
"label": "aggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.filterable",
|
|
"type": "CompoundType",
|
|
"label": "filterable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.searchable",
|
|
"type": "CompoundType",
|
|
"label": "searchable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.sortable",
|
|
"type": "CompoundType",
|
|
"label": "sortable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.visualizable",
|
|
"type": "CompoundType",
|
|
"label": "visualizable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.readFromDocValues",
|
|
"type": "CompoundType",
|
|
"label": "readFromDocValues",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.scripted",
|
|
"type": "CompoundType",
|
|
"label": "scripted",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.subType",
|
|
"type": "Object",
|
|
"label": "subType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldSubType",
|
|
"text": "IFieldSubType"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.displayName",
|
|
"type": "string",
|
|
"label": "displayName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.customLabel",
|
|
"type": "string",
|
|
"label": "customLabel",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.format",
|
|
"type": "Any",
|
|
"label": "format",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IFieldType.toSpec",
|
|
"type": "Function",
|
|
"label": "toSpec",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"signature": [
|
|
"((options?: { getFormatterForField?: ((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined; } | undefined) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPattern",
|
|
"type": "Interface",
|
|
"label": "IIndexPattern",
|
|
"description": [
|
|
"\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.fields",
|
|
"type": "Array",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 33
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [
|
|
"\nType is used for identifying rollup indices, otherwise left undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.timeFieldName",
|
|
"type": "string",
|
|
"label": "timeFieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPattern.getTimeField",
|
|
"type": "Function",
|
|
"label": "getTimeField",
|
|
"signature": [
|
|
"(() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | undefined) | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 40
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.fieldFormatMap",
|
|
"type": "Object",
|
|
"label": "fieldFormatMap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<unknown> | undefined> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPattern.getFormatterForField",
|
|
"type": "Function",
|
|
"label": "getFormatterForField",
|
|
"description": [
|
|
"\nLook up a formatter for a given field"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"signature": [
|
|
"((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList",
|
|
"type": "Interface",
|
|
"label": "IIndexPatternFieldList",
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPatternFieldList",
|
|
"text": "IIndexPatternFieldList"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.add",
|
|
"type": "Function",
|
|
"label": "add",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 18
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 18
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.getAll",
|
|
"type": "Function",
|
|
"label": "getAll",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 19
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.getByName",
|
|
"type": "Function",
|
|
"label": "getByName",
|
|
"signature": [
|
|
"(name: string) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "name",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 20
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 20
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.getByType",
|
|
"type": "Function",
|
|
"label": "getByType",
|
|
"signature": [
|
|
"(type: string) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "type",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 21
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.remove",
|
|
"type": "Function",
|
|
"label": "remove",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 22
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.removeAll",
|
|
"type": "Function",
|
|
"label": "removeAll",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 23
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.replaceAll",
|
|
"type": "Function",
|
|
"label": "replaceAll",
|
|
"signature": [
|
|
"(specs: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Array",
|
|
"label": "specs",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 24
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 24
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.update",
|
|
"type": "Function",
|
|
"label": "update",
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "field",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 25
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 25
|
|
}
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.toSpec",
|
|
"type": "Function",
|
|
"label": "toSpec",
|
|
"signature": [
|
|
"(options?: { getFormatterForField?: ((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined; } | undefined) => Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-common.IIndexPatternFieldList.toSpec.options",
|
|
"type": "Object",
|
|
"label": "options",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPatternFieldList.toSpec.options.getFormatterForField",
|
|
"type": "Function",
|
|
"label": "getFormatterForField",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IIndexPatternsApiClient",
|
|
"type": "Interface",
|
|
"label": "IIndexPatternsApiClient",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern",
|
|
"type": "Function",
|
|
"label": "getFieldsForTimePattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 135
|
|
},
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptionsTimePattern",
|
|
"text": "GetFieldsOptionsTimePattern"
|
|
},
|
|
") => Promise<any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard",
|
|
"type": "Function",
|
|
"label": "getFieldsForWildcard",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 136
|
|
},
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.GetFieldsOptions",
|
|
"text": "GetFieldsOptions"
|
|
},
|
|
") => Promise<any>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 134
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternAttributes",
|
|
"type": "Interface",
|
|
"label": "IndexPatternAttributes",
|
|
"description": [
|
|
"\nInterface for an index pattern saved object"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 54
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.fields",
|
|
"type": "string",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 55
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 56
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.typeMeta",
|
|
"type": "string",
|
|
"label": "typeMeta",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 57
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.timeFieldName",
|
|
"type": "string",
|
|
"label": "timeFieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.intervalName",
|
|
"type": "string",
|
|
"label": "intervalName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.sourceFilters",
|
|
"type": "string",
|
|
"label": "sourceFilters",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.fieldFormatMap",
|
|
"type": "string",
|
|
"label": "fieldFormatMap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.fieldAttrs",
|
|
"type": "string",
|
|
"label": "fieldAttrs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.runtimeFieldMap",
|
|
"type": "string",
|
|
"label": "runtimeFieldMap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternAttributes.allowNoIndex",
|
|
"type": "CompoundType",
|
|
"label": "allowNoIndex",
|
|
"description": [
|
|
"\nprevents errors when index pattern exists before indices"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 67
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternExpressionType",
|
|
"type": "Interface",
|
|
"label": "IndexPatternExpressionType",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternExpressionType.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"signature": [
|
|
"\"index_pattern\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternExpressionType.value",
|
|
"type": "Object",
|
|
"label": "value",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternSpec",
|
|
"text": "IndexPatternSpec"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternSpec",
|
|
"type": "Interface",
|
|
"label": "IndexPatternSpec",
|
|
"description": [
|
|
"\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"\nsaved object id"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 228
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.version",
|
|
"type": "string",
|
|
"label": "version",
|
|
"description": [
|
|
"\nsaved object version string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 232
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 233
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"id": "def-common.IndexPatternSpec.intervalName",
|
|
"type": "string",
|
|
"label": "intervalName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 238
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.timeFieldName",
|
|
"type": "string",
|
|
"label": "timeFieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 239
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.sourceFilters",
|
|
"type": "Array",
|
|
"label": "sourceFilters",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 240
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.SourceFilter",
|
|
"text": "SourceFilter"
|
|
},
|
|
"[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.fields",
|
|
"type": "Object",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 241
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
"> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.typeMeta",
|
|
"type": "Object",
|
|
"label": "typeMeta",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 242
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.TypeMeta",
|
|
"text": "TypeMeta"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 243
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.fieldFormats",
|
|
"type": "Object",
|
|
"label": "fieldFormats",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 244
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.runtimeFieldMap",
|
|
"type": "Object",
|
|
"label": "runtimeFieldMap",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 245
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
"> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.fieldAttrs",
|
|
"type": "Object",
|
|
"label": "fieldAttrs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 246
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.FieldAttrs",
|
|
"text": "FieldAttrs"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.IndexPatternSpec.allowNoIndex",
|
|
"type": "CompoundType",
|
|
"label": "allowNoIndex",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 247
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 224
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.RuntimeField",
|
|
"type": "Interface",
|
|
"label": "RuntimeField",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.RuntimeField.type",
|
|
"type": "CompoundType",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.RuntimeField.script",
|
|
"type": "Object",
|
|
"label": "script",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"{ source: string; } | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.SavedObjectsClientCommon",
|
|
"type": "Interface",
|
|
"label": "SavedObjectsClientCommon",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommon.find",
|
|
"type": "Function",
|
|
"label": "find",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 102
|
|
},
|
|
"signature": [
|
|
"<T = unknown>(options: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.SavedObjectsClientCommonFindArgs",
|
|
"text": "SavedObjectsClientCommonFindArgs"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<T>[]>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommon.get",
|
|
"type": "Function",
|
|
"label": "get",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 103
|
|
},
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<T>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommon.update",
|
|
"type": "Function",
|
|
"label": "update",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 104
|
|
},
|
|
"signature": [
|
|
"(type: string, id: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<unknown>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommon.create",
|
|
"type": "Function",
|
|
"label": "create",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 110
|
|
},
|
|
"signature": [
|
|
"(type: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
"<unknown>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommon.delete",
|
|
"type": "Function",
|
|
"label": "delete",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 115
|
|
},
|
|
"signature": [
|
|
"(type: string, id: string) => Promise<{}>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 101
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs",
|
|
"type": "Interface",
|
|
"label": "SavedObjectsClientCommonFindArgs",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs.type",
|
|
"type": "CompoundType",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 94
|
|
},
|
|
"signature": [
|
|
"string | string[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs.fields",
|
|
"type": "Array",
|
|
"label": "fields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs.perPage",
|
|
"type": "number",
|
|
"label": "perPage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 96
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs.search",
|
|
"type": "string",
|
|
"label": "search",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 97
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SavedObjectsClientCommonFindArgs.searchFields",
|
|
"type": "Array",
|
|
"label": "searchFields",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 98
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 93
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.SourceFilter",
|
|
"type": "Interface",
|
|
"label": "SourceFilter",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.SourceFilter.value",
|
|
"type": "string",
|
|
"label": "value",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 251
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 250
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.TypeMeta",
|
|
"type": "Interface",
|
|
"label": "TypeMeta",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.TypeMeta.aggs",
|
|
"type": "Object",
|
|
"label": "aggs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 159
|
|
},
|
|
"signature": [
|
|
"Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-common.TypeMeta.Unnamed",
|
|
"type": "Any",
|
|
"label": "Unnamed",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 160
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 158
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.UiSettingsCommon",
|
|
"type": "Interface",
|
|
"label": "UiSettingsCommon",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.UiSettingsCommon.get",
|
|
"type": "Function",
|
|
"label": "get",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 87
|
|
},
|
|
"signature": [
|
|
"(key: string) => Promise<any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.UiSettingsCommon.getAll",
|
|
"type": "Function",
|
|
"label": "getAll",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"signature": [
|
|
"() => Promise<Record<string, any>>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.UiSettingsCommon.set",
|
|
"type": "Function",
|
|
"label": "set",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"signature": [
|
|
"(key: string, value: any) => Promise<void>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.UiSettingsCommon.remove",
|
|
"type": "Function",
|
|
"label": "remove",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"signature": [
|
|
"(key: string) => Promise<void>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 86
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-common.AggregationRestrictions",
|
|
"type": "Type",
|
|
"label": "AggregationRestrictions",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 141
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.FieldFormatMap",
|
|
"type": "Type",
|
|
"label": "FieldFormatMap",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: SerializedFieldFormat<Record<string, any>>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.FieldSpecConflictDescriptions",
|
|
"type": "Type",
|
|
"label": "FieldSpecConflictDescriptions",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 163
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: string[]; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternFieldMap",
|
|
"type": "Type",
|
|
"label": "IndexPatternFieldMap",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 218
|
|
},
|
|
"signature": [
|
|
"{ [x: string]: FieldSpec; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternLoadExpressionFunctionDefinition",
|
|
"type": "Type",
|
|
"label": "IndexPatternLoadExpressionFunctionDefinition",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"signature": [
|
|
"ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExecutionContext",
|
|
"text": "ExecutionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.IndexPatternsContract",
|
|
"type": "Type",
|
|
"label": "IndexPatternsContract",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
|
|
"lineNumber": 639
|
|
},
|
|
"signature": [
|
|
"{ get: (id: string) => Promise<IndexPattern>; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise<IndexPattern>; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; find: (search: string, size?: number) => Promise<IndexPattern[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>; getDefault: () => Promise<IndexPattern | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>; refreshFields: (indexPattern: IndexPattern) => Promise<void>; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>; savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise<IndexPattern>; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise<IndexPattern>; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.OnError",
|
|
"type": "Type",
|
|
"label": "OnError",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"signature": [
|
|
"(error: Error, toastInputFields: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
},
|
|
") => void"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.OnNotification",
|
|
"type": "Type",
|
|
"label": "OnNotification",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 83
|
|
},
|
|
"signature": [
|
|
"(toastInputFields: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInputFields",
|
|
"text": "ToastInputFields"
|
|
},
|
|
") => void"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.RuntimeType",
|
|
"type": "Type",
|
|
"label": "RuntimeType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"signature": [
|
|
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.RUNTIME_FIELD_TYPES",
|
|
"type": "Object",
|
|
"label": "RUNTIME_FIELD_TYPES",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/index_patterns/constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"signature": [
|
|
"readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |