maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/data_index_patterns.json
Liza Katz 204efae5bf
[Data cleanup] unify serializable state (#107745) 
* Use Serializable from package

* Rename to align with core

* fix

* more replacements

* docssss

* fix

* Move it to @kbn/utility-types and remove core export

* buildy build

* tests

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-08-10 13:03:48 +02:00

8840 lines
318 KiB
JSON
Raw Blame History

{
"id": "data.indexPatterns",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher",
"type": "Class",
"tags": [],
"label": "IndexPatternsFetcher",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "elasticsearchClient",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.Unnamed.$2",
"type": "boolean",
"tags": [],
"label": "allowNoIndices",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard",
"type": "Function",
"tags": [
"property",
"property",
"return"
],
"label": "getFieldsForWildcard",
"description": [
"\n Get a list of field objects for an index pattern that may contain wildcards\n"
],
"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"
},
"[]>"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.pattern",
"type": "CompoundType",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.fieldCapsOptions",
"type": "Object",
"tags": [],
"label": "fieldCapsOptions",
"description": [],
"signature": [
"{ allow_no_indices: boolean; } | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.options.rollupIndex",
"type": "string",
"tags": [],
"label": "rollupIndex",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern",
"type": "Function",
"tags": [
"property",
"property",
"property",
"return"
],
"label": "getFieldsForTimePattern",
"description": [
"\n Get a list of field objects for a time pattern\n"
],
"signature": [
"(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
"[]>"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.pattern",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.lookBack",
"type": "number",
"tags": [],
"label": "lookBack",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForTimePattern.$1.options.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.validatePatternListActive",
"type": "Function",
"tags": [
"return"
],
"label": "validatePatternListActive",
"description": [
"\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n"
],
"signature": [
"(patternList: string[]) => Promise<string[]>"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.validatePatternListActive.$1",
"type": "Array",
"tags": [],
"label": "patternList",
"description": [
"string[]"
],
"signature": [
"string[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"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>"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"IndexPatternsServiceStartDeps",
", ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">, { expressions, usageCollection }: ",
"IndexPatternsServiceSetupDeps",
") => void"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
"IndexPatternsServiceStartDeps",
", ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.setup.$2",
"type": "Object",
"tags": [],
"label": "{ expressions, usageCollection }",
"description": [],
"signature": [
"IndexPatternsServiceSetupDeps"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
", { fieldFormats, logger }: ",
"IndexPatternsServiceStartDeps",
") => { indexPatternsServiceFactory: (savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, 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"
},
">; }"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsServiceProvider.start.$2",
"type": "Object",
"tags": [],
"label": "{ fieldFormats, logger }",
"description": [],
"signature": [
"IndexPatternsServiceStartDeps"
],
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "data",
"id": "def-server.getCapabilitiesForRollupIndices",
"type": "Function",
"tags": [],
"label": "getCapabilitiesForRollupIndices",
"description": [],
"signature": [
"(indices: Record<string, { rollup_jobs: any; }>) => { [key: string]: any; }"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.getCapabilitiesForRollupIndices.$1",
"type": "Object",
"tags": [],
"label": "indices",
"description": [],
"signature": [
"Record<string, { rollup_jobs: any; }>"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-server.mergeCapabilitiesWithFields",
"type": "Function",
"tags": [],
"label": "mergeCapabilitiesWithFields",
"description": [],
"signature": [
"(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: Record<string, ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
">, 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"
},
"[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities",
"type": "Object",
"tags": [],
"label": "rollupIndexCapabilities",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.mergeCapabilitiesWithFields.$1.rollupIndexCapabilities.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-server.mergeCapabilitiesWithFields.$2",
"type": "Object",
"tags": [],
"label": "fieldsFromFieldCapsApi",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
">"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.mergeCapabilitiesWithFields.$3",
"type": "Array",
"tags": [],
"label": "previousFields",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-server.FieldDescriptor",
"text": "FieldDescriptor"
},
"[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-server.shouldReadFieldFromDocValues",
"type": "Function",
"tags": [],
"label": "shouldReadFieldFromDocValues",
"description": [],
"signature": [
"(aggregatable: boolean, esType: string) => boolean"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.shouldReadFieldFromDocValues.$1",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-server.shouldReadFieldFromDocValues.$2",
"type": "string",
"tags": [],
"label": "esType",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor",
"type": "Interface",
"tags": [],
"label": "FieldDescriptor",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.readFromDocValues",
"type": "boolean",
"tags": [],
"label": "readFromDocValues",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.subType",
"type": "Object",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"FieldSubType | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor",
"type": "Interface",
"tags": [],
"label": "FieldDescriptor",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.readFromDocValues",
"type": "boolean",
"tags": [],
"label": "readFromDocValues",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-server.FieldDescriptor.subType",
"type": "Object",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"FieldSubType | undefined"
],
"path": "src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "data",
"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"
],
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.DuplicateIndexPatternError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.DuplicateIndexPatternError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"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"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.fieldFormatMap",
"type": "Object",
"tags": [],
"label": "fieldFormatMap",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.typeMeta",
"type": "Object",
"tags": [],
"label": "typeMeta",
"description": [
"\nOnly used by rollup indices, used by rollup specific endpoint to load field list"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.fields",
"type": "CompoundType",
"tags": [],
"label": "fields",
"description": [],
"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"
},
">; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.intervalName",
"type": "string",
"tags": [
"deprecated"
],
"label": "intervalName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": true,
"references": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nType is used to identify rollup index patterns"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.formatHit",
"type": "Function",
"tags": [],
"label": "formatHit",
"description": [],
"signature": [
"{ (hit: Record<string, any>, type?: string | undefined): any; formatField: FormatFieldFn; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.hit",
"type": "Object",
"tags": [],
"label": "hit",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.formatField",
"type": "Function",
"tags": [],
"label": "formatField",
"description": [],
"signature": [
"(hit: Record<string, any>, fieldName: string) => any"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.hit",
"type": "Object",
"tags": [],
"label": "hit",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.flattenHit",
"type": "Function",
"tags": [],
"label": "flattenHit",
"description": [],
"signature": [
"(hit: Record<string, any>, deep?: boolean | undefined) => Record<string, any>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.hit",
"type": "Object",
"tags": [],
"label": "hit",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.deep",
"type": "CompoundType",
"tags": [],
"label": "deep",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nSavedObject version"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.sourceFilters",
"type": "Array",
"tags": [],
"label": "sourceFilters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.allowNoIndex",
"type": "boolean",
"tags": [],
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }",
"description": [],
"signature": [
"IndexPatternDeps"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getOriginalSavedObjectBody",
"type": "Function",
"tags": [],
"label": "getOriginalSavedObjectBody",
"description": [
"\nGet last saved saved object fields"
],
"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; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.resetOriginalSavedObjectBody",
"type": "Function",
"tags": [],
"label": "resetOriginalSavedObjectBody",
"description": [
"\nReset last saved saved object fields. used after saving"
],
"signature": [
"() => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFieldAttrs",
"type": "Function",
"tags": [],
"label": "getFieldAttrs",
"description": [],
"signature": [
"() => { [x: string]: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getComputedFields",
"type": "Function",
"tags": [],
"label": "getComputedFields",
"description": [],
"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"
},
">; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.toSpec",
"type": "Function",
"tags": [],
"label": "toSpec",
"description": [
"\nCreate static representation of index pattern"
],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getSourceFiltering",
"type": "Function",
"tags": [],
"label": "getSourceFiltering",
"description": [
"\nGet the source filtering configuration for that index."
],
"signature": [
"() => { excludes: any[]; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addScriptedField",
"type": "Function",
"tags": [
"deprecated"
],
"label": "addScriptedField",
"description": [
"\nAdd scripted field to field list\n"
],
"signature": [
"(name: string, script: string, fieldType?: string) => Promise<void>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": true,
"references": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addScriptedField.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [
"field name"
],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addScriptedField.$2",
"type": "string",
"tags": [],
"label": "script",
"description": [
"script code"
],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addScriptedField.$3",
"type": "string",
"tags": [],
"label": "fieldType",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.removeScriptedField",
"type": "Function",
"tags": [
"deprecated"
],
"label": "removeScriptedField",
"description": [
"\nRemove scripted field from field list"
],
"signature": [
"(fieldName: string) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": true,
"references": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.removeScriptedField.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getNonScriptedFields",
"type": "Function",
"tags": [
"deprecated"
],
"label": "getNonScriptedFields",
"description": [
"\n"
],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": true,
"references": [
{
"plugin": "visTypeTimeseries",
"path": "src/plugins/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/services/persistence/deserialize.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/state_management/datasource.test.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts"
},
{
"plugin": "graph",
"path": "x-pack/plugins/graph/public/services/persistence/deserialize.test.ts"
}
],
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getScriptedFields",
"type": "Function",
"tags": [
"deprecated"
],
"label": "getScriptedFields",
"description": [
"\n"
],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": true,
"references": [],
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.isTimeBased",
"type": "Function",
"tags": [],
"label": "isTimeBased",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.isTimeNanosBased",
"type": "Function",
"tags": [],
"label": "isTimeNanosBased",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getTimeField",
"type": "Function",
"tags": [],
"label": "getTimeField",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFieldByName",
"type": "Function",
"tags": [],
"label": "getFieldByName",
"description": [],
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFieldByName.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getAggregationRestrictions",
"type": "Function",
"tags": [],
"label": "getAggregationRestrictions",
"description": [],
"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"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getAsSavedObjectBody",
"type": "Function",
"tags": [],
"label": "getAsSavedObjectBody",
"description": [
"\nReturns index pattern as saved object body for saving"
],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFormatterForField",
"type": "Function",
"tags": [],
"label": "getFormatterForField",
"description": [
"\nProvide a field, get its formatter"
],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFormatterForField.$1",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addRuntimeField",
"type": "Function",
"tags": [],
"label": "addRuntimeField",
"description": [
"\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"
],
"signature": [
"(name: string, runtimeField: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addRuntimeField.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [
"Field name"
],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.addRuntimeField.$2",
"type": "Object",
"tags": [],
"label": "runtimeField",
"description": [
"Runtime field definition"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.hasRuntimeField",
"type": "Function",
"tags": [],
"label": "hasRuntimeField",
"description": [
"\nChecks if runtime field exists"
],
"signature": [
"(name: string) => boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.hasRuntimeField.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getRuntimeField",
"type": "Function",
"tags": [],
"label": "getRuntimeField",
"description": [
"\nReturns runtime field if exists"
],
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | null"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getRuntimeField.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.replaceAllRuntimeFields",
"type": "Function",
"tags": [],
"label": "replaceAllRuntimeFields",
"description": [
"\nReplaces all existing runtime fields with new fields"
],
"signature": [
"(newFields: Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
">) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.replaceAllRuntimeFields.$1",
"type": "Object",
"tags": [],
"label": "newFields",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.removeRuntimeField",
"type": "Function",
"tags": [],
"label": "removeRuntimeField",
"description": [
"\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate. Doesn't clear associated field attributes."
],
"signature": [
"(name: string) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.removeRuntimeField.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [
"- Field name to remove"
],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFormatterForFieldNoDefault",
"type": "Function",
"tags": [],
"label": "getFormatterForFieldNoDefault",
"description": [
"\nGet formatter for a given field name. Return undefined if none exists"
],
"signature": [
"(fieldname: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.getFormatterForFieldNoDefault.$1",
"type": "string",
"tags": [],
"label": "fieldname",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldAttrs",
"type": "Function",
"tags": [],
"label": "setFieldAttrs",
"description": [],
"signature": [
"<K extends \"customLabel\" | \"count\">(fieldName: string, attrName: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldAttrs.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldAttrs.$2",
"type": "Uncategorized",
"tags": [],
"label": "attrName",
"description": [],
"signature": [
"K"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldAttrs.$3",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrSet",
"text": "FieldAttrSet"
},
"[K]"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCustomLabel",
"type": "Function",
"tags": [],
"label": "setFieldCustomLabel",
"description": [],
"signature": [
"(fieldName: string, customLabel: string | null | undefined) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCustomLabel.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCustomLabel.$2",
"type": "CompoundType",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCount",
"type": "Function",
"tags": [],
"label": "setFieldCount",
"description": [],
"signature": [
"(fieldName: string, count: number | null | undefined) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCount.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldCount.$2",
"type": "CompoundType",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldFormat",
"type": "Function",
"tags": [],
"label": "setFieldFormat",
"description": [],
"signature": [
"(fieldName: string, format: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldFormat.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.setFieldFormat.$2",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.deleteFieldFormat",
"type": "Function",
"tags": [],
"label": "deleteFieldFormat",
"description": [],
"signature": [
"(fieldName: string) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPattern.deleteFieldFormat.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"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"
}
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.spec",
"type": "Object",
"tags": [],
"label": "spec",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "spec",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.count",
"type": "number",
"tags": [],
"label": "count",
"description": [
"\nCount is used for field popularity"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.runtimeField",
"type": "Object",
"tags": [],
"label": "runtimeField",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.runtimeField",
"type": "Object",
"tags": [],
"label": "runtimeField",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.script",
"type": "string",
"tags": [],
"label": "script",
"description": [
"\nScript field code"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.script",
"type": "string",
"tags": [],
"label": "script",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.lang",
"type": "CompoundType",
"tags": [],
"label": "lang",
"description": [
"\nScript field language"
],
"signature": [
"\"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.lang",
"type": "CompoundType",
"tags": [],
"label": "lang",
"description": [],
"signature": [
"\"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.customLabel",
"type": "string",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.customLabel",
"type": "string",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.conflictDescriptions",
"type": "Object",
"tags": [],
"label": "conflictDescriptions",
"description": [
"\nDescription of field type conflicts across different indices in the same index pattern"
],
"signature": [
"Record<string, string[]> | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.conflictDescriptions",
"type": "Object",
"tags": [],
"label": "conflictDescriptions",
"description": [],
"signature": [
"Record<string, string[]> | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.scripted",
"type": "boolean",
"tags": [],
"label": "scripted",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.readFromDocValues",
"type": "boolean",
"tags": [],
"label": "readFromDocValues",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.subType",
"type": "Object",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"IFieldSubType",
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.isMapped",
"type": "CompoundType",
"tags": [],
"label": "isMapped",
"description": [
"\nIs the field part of the index mapping?"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.sortable",
"type": "boolean",
"tags": [],
"label": "sortable",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.filterable",
"type": "boolean",
"tags": [],
"label": "filterable",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.visualizable",
"type": "boolean",
"tags": [],
"label": "visualizable",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.deleteCount",
"type": "Function",
"tags": [],
"label": "deleteCount",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.toJSON",
"type": "Function",
"tags": [],
"label": "toJSON",
"description": [],
"signature": [
"() => { count: number; script: string | undefined; lang: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; conflictDescriptions: Record<string, string[]> | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",
"IFieldSubType",
" | undefined; customLabel: string | undefined; }"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.toSpec",
"type": "Function",
"tags": [],
"label": "toSpec",
"description": [],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField",
"type": "Object",
"tags": [],
"label": "{\n getFormatterForField,\n }",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternField.toSpec.$1.getFormatterForField.getFormatterForField",
"type": "Function",
"tags": [],
"label": "getFormatterForField",
"description": [],
"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"
],
"path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService",
"type": "Class",
"tags": [],
"label": "IndexPatternsService",
"description": [],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.ensureDefaultIndexPattern",
"type": "Function",
"tags": [],
"label": "ensureDefaultIndexPattern",
"description": [],
"signature": [
"() => Promise<unknown> | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }",
"description": [],
"signature": [
"IndexPatternsServiceDeps"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getIds",
"type": "Function",
"tags": [],
"label": "getIds",
"description": [
"\nGet list of index pattern ids"
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getIds.$1",
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getTitles",
"type": "Function",
"tags": [],
"label": "getTitles",
"description": [
"\nGet list of index pattern titles"
],
"signature": [
"(refresh?: boolean) => Promise<string[]>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getTitles.$1",
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [
"\nFind and load index patterns by title"
],
"signature": [
"(search: string, size?: number) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.find.$1",
"type": "string",
"tags": [],
"label": "search",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.find.$2",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"IndexPattern[]"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getIdsWithTitle",
"type": "Function",
"tags": [],
"label": "getIdsWithTitle",
"description": [
"\nGet list of index pattern ids with titles"
],
"signature": [
"(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getIdsWithTitle.$1",
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.clearCache",
"type": "Function",
"tags": [],
"label": "clearCache",
"description": [
"\nClear index pattern list cache"
],
"signature": [
"(id?: string | undefined) => void"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.clearCache.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"optionally clear a single id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getCache",
"type": "Function",
"tags": [],
"label": "getCache",
"description": [],
"signature": [
"() => Promise<",
"SavedObject",
"<",
"IndexPatternSavedObjectAttrs",
">[] | null | undefined>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getDefault",
"type": "Function",
"tags": [],
"label": "getDefault",
"description": [
"\nGet default index pattern"
],
"signature": [
"() => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | null>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getDefaultId",
"type": "Function",
"tags": [],
"label": "getDefaultId",
"description": [
"\nGet default index pattern id"
],
"signature": [
"() => Promise<string | null>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.setDefault",
"type": "Function",
"tags": [],
"label": "setDefault",
"description": [
"\nOptionally set default index pattern, unless force = true"
],
"signature": [
"(id: string | null, force?: boolean) => Promise<void>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.setDefault.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.setDefault.$2",
"type": "boolean",
"tags": [],
"label": "force",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getFieldsForWildcard",
"type": "Function",
"tags": [],
"label": "getFieldsForWildcard",
"description": [
"\nGet field list by providing { pattern }"
],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getFieldsForWildcard.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getFieldsForIndexPattern",
"type": "Function",
"tags": [],
"label": "getFieldsForIndexPattern",
"description": [
"\nGet field list by providing an index patttern (or spec)"
],
"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>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$1",
"type": "CompoundType",
"tags": [],
"label": "indexPattern",
"description": [],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getFieldsForIndexPattern.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.refreshFields",
"type": "Function",
"tags": [],
"label": "refreshFields",
"description": [
"\nRefresh field list for a given index pattern"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => Promise<void>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.refreshFields.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.fieldArrayToMap",
"type": "Function",
"tags": [],
"label": "fieldArrayToMap",
"description": [
"\nConverts field array to map"
],
"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"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.fieldArrayToMap.$1",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
": FieldSpec[]"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.fieldArrayToMap.$2",
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [
": FieldAttrs"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [
"Record<string, FieldSpec>"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.savedObjectToSpec",
"type": "Function",
"tags": [],
"label": "savedObjectToSpec",
"description": [
"\nConverts index pattern saved object to index pattern spec"
],
"signature": [
"(savedObject: ",
"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"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.savedObjectToSpec.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
"SavedObject",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternAttributes",
"text": "IndexPatternAttributes"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"IndexPatternSpec"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"\nGet an index pattern by id. Cache optimized"
],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.get.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [
"\nCreate a new index pattern instance"
],
"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"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.create.$1",
"type": "Object",
"tags": [],
"label": "spec",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.create.$2",
"type": "boolean",
"tags": [],
"label": "skipFetchFields",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"IndexPattern"
]
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createAndSave",
"type": "Function",
"tags": [],
"label": "createAndSave",
"description": [
"\nCreate a new index pattern and save it right away"
],
"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"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createAndSave.$1",
"type": "Object",
"tags": [],
"label": "spec",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createAndSave.$2",
"type": "boolean",
"tags": [],
"label": "override",
"description": [
"Overwrite if existing index pattern exists."
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createAndSave.$3",
"type": "boolean",
"tags": [],
"label": "skipFetchFields",
"description": [
"Whether to skip field refresh step."
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createSavedObject",
"type": "Function",
"tags": [],
"label": "createSavedObject",
"description": [
"\nSave a new index pattern"
],
"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"
},
">"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createSavedObject.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.createSavedObject.$2",
"type": "boolean",
"tags": [],
"label": "override",
"description": [
"Overwrite if existing index pattern exists"
],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.updateSavedObject",
"type": "Function",
"tags": [],
"label": "updateSavedObject",
"description": [
"\nSave existing index pattern. Will attempt to merge differences if there are conflicts"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.updateSavedObject.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.updateSavedObject.$2",
"type": "number",
"tags": [],
"label": "saveAttempts",
"description": [],
"signature": [
"number"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.updateSavedObject.$3",
"type": "boolean",
"tags": [],
"label": "ignoreErrors",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [
"\nDeletes an index pattern from .kibana index"
],
"signature": [
"(indexPatternId: string) => Promise<{}>"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.delete.$1",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [
": Id of kibana Index Pattern to delete"
],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "data",
"id": "def-common.fieldList",
"type": "Function",
"tags": [],
"label": "fieldList",
"description": [],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.fieldList.$1",
"type": "Array",
"tags": [],
"label": "specs",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.fieldList.$2",
"type": "boolean",
"tags": [],
"label": "shortDotsEnable",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.getIndexPatternLoadMeta",
"type": "Function",
"tags": [],
"label": "getIndexPatternLoadMeta",
"description": [],
"signature": [
"() => Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternLoadExpressionFunctionDefinition",
"text": "IndexPatternLoadExpressionFunctionDefinition"
},
", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"help\" | \"disabled\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">"
],
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.isFilterable",
"type": "Function",
"tags": [],
"label": "isFilterable",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => boolean"
],
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.isFilterable.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.isNestedField",
"type": "Function",
"tags": [],
"label": "isNestedField",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => boolean"
],
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.isNestedField.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"path": "src/plugins/data/common/index_patterns/fields/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "data",
"id": "def-common.FieldAttrs",
"type": "Interface",
"tags": [
"intenal"
],
"label": "FieldAttrs",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.FieldAttrs.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldAttrSet",
"type": "Interface",
"tags": [],
"label": "FieldAttrSet",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.FieldAttrSet.customLabel",
"type": "string",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldAttrSet.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec",
"type": "Interface",
"tags": [],
"label": "FieldSpec",
"description": [
"\nSerialized version of IndexPatternField"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
" extends ",
"IndexPatternFieldBase"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.count",
"type": "number",
"tags": [],
"label": "count",
"description": [
"\nPopularity count is used by discover"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.conflictDescriptions",
"type": "Object",
"tags": [],
"label": "conflictDescriptions",
"description": [],
"signature": [
"Record<string, string[]> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.readFromDocValues",
"type": "CompoundType",
"tags": [],
"label": "readFromDocValues",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.indexed",
"type": "CompoundType",
"tags": [],
"label": "indexed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.customLabel",
"type": "string",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.runtimeField",
"type": "Object",
"tags": [],
"label": "runtimeField",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.shortDotsEnable",
"type": "CompoundType",
"tags": [],
"label": "shortDotsEnable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpec.isMapped",
"type": "CompoundType",
"tags": [],
"label": "isMapped",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt",
"type": "Interface",
"tags": [],
"label": "FieldSpecExportFmt",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.script",
"type": "string",
"tags": [],
"label": "script",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.lang",
"type": "CompoundType",
"tags": [],
"label": "lang",
"description": [],
"signature": [
"\"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.conflictDescriptions",
"type": "Object",
"tags": [],
"label": "conflictDescriptions",
"description": [],
"signature": [
"Record<string, string[]> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
"KBN_FIELD_TYPES"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.scripted",
"type": "boolean",
"tags": [],
"label": "scripted",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.readFromDocValues",
"type": "CompoundType",
"tags": [],
"label": "readFromDocValues",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.subType",
"type": "Object",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"IFieldSubType",
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecExportFmt.indexed",
"type": "CompoundType",
"tags": [],
"label": "indexed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions",
"type": "Interface",
"tags": [],
"label": "GetFieldsOptions",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.pattern",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.lookBack",
"type": "CompoundType",
"tags": [],
"label": "lookBack",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.rollupIndex",
"type": "string",
"tags": [],
"label": "rollupIndex",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.allowNoIndex",
"type": "CompoundType",
"tags": [],
"label": "allowNoIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptionsTimePattern",
"type": "Interface",
"tags": [],
"label": "GetFieldsOptionsTimePattern",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptionsTimePattern.pattern",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptionsTimePattern.metaFields",
"type": "Array",
"tags": [],
"label": "metaFields",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptionsTimePattern.lookBack",
"type": "number",
"tags": [],
"label": "lookBack",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptionsTimePattern.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "IFieldType",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" extends ",
"IndexPatternFieldBase"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": true,
"references": [
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/components/search_bar.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/components/search_bar.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/components/search_bar.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/fields/es_doc_field.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/index_pattern_util.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/top_hits_form.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/update_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/metrics_editor/metric_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/metrics_editor/metrics_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_geo_line_source/update_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_geo_line_source/update_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/layers/choropleth_layer_wizard/layer_template.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/layers/choropleth_layer_wizard/layer_template.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/layers/choropleth_layer_wizard/layer_template.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/layers/choropleth_layer_wizard/layer_template.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/components/data_grid/common.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/components/data_grid/common.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/metric_control/index.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/inventory/components/metric.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/common/group_by_expression/selector.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/common/group_by_expression/selector.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/common/group_by_expression/group_by_expression.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/common/group_by_expression/group_by_expression.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criteria.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criteria.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/group_by.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/group_by.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_row.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/metrics.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/metrics.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx"
},
{
"plugin": "fleet",
"path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/server/maps_telemetry/maps_telemetry.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/server/maps_telemetry/maps_telemetry.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/util_components/single_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/sources/es_source/es_source.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/index_pattern_util.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.test.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.test.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.test.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.test.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.test.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/components/single_field_select.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/group_by_expression.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/common/group_by_expression/selector.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/expression.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/inventory/components/metric.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_row.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/layers/choropleth_layer_wizard/layer_template.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/layers/choropleth_layer_wizard/layer_template.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/layers/choropleth_layer_wizard/layer_template.d.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/target/types/public/classes/layers/choropleth_layer_wizard/layer_template.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criteria.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/log_threshold/components/expression_editor/criterion.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/group_by.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/components/metrics.d.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/target/types/public/alert_types/geo_containment/query_builder/util_components/single_field_select.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/custom_field_panel.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/waffle_group_by_controls.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/common/elasticsearch_util/es_agg_utils.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/geo_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/components/geo_field_select.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/target/types/public/indexpattern_datasource/types.d.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_by_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts"
},
{
"plugin": "maps",
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts"
}
],
"children": [
{
"parentPluginId": "data",
"id": "def-common.IFieldType.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.aggregatable",
"type": "CompoundType",
"tags": [],
"label": "aggregatable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.filterable",
"type": "CompoundType",
"tags": [],
"label": "filterable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.searchable",
"type": "CompoundType",
"tags": [],
"label": "searchable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.sortable",
"type": "CompoundType",
"tags": [],
"label": "sortable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.visualizable",
"type": "CompoundType",
"tags": [],
"label": "visualizable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.readFromDocValues",
"type": "CompoundType",
"tags": [],
"label": "readFromDocValues",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.customLabel",
"type": "string",
"tags": [],
"label": "customLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.format",
"type": "Any",
"tags": [],
"label": "format",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IFieldType.toSpec",
"type": "Function",
"tags": [],
"label": "toSpec",
"description": [],
"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"
},
") | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IFieldType.toSpec.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IFieldType.toSpec.$1.options.getFormatterForField",
"type": "Function",
"tags": [],
"label": "getFormatterForField",
"description": [],
"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"
],
"path": "src/plugins/data/common/index_patterns/fields/types.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "IIndexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" extends ",
"IndexPatternBase"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": true,
"references": [
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/pages/alerts/alerts_search_bar.tsx"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/pages/alerts/alerts_search_bar.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/utils/keury/index.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/utils/keury/index.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/utils/keury/index.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/utils/keury/index.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/t_grid/helpers.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/t_grid/helpers.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/container/source/index.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/container/source/index.tsx"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/container/source/index.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/kuery_bar.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/kuery_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/index_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/util/index_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/new_job_capabilities_service_analytics.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/new_job_capabilities_service_analytics.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/components/data_recognizer/data_recognizer.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/components/data_recognizer/data_recognizer.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/new_job_capabilities_service.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/new_job_capabilities_service.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/load_new_job_capabilities.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/services/new_job_capabilities/load_new_job_capabilities.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/toolbars/toolbar.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/inventory_view/components/toolbars/toolbar.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/utils/kuery.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/utils/kuery.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/with_source/with_source.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/containers/with_source/with_source.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/toolbar.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/components/toolbar.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/index.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/metrics_explorer/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/containers/source/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/containers/source/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/containers/source/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/lib/keury/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/lib/keury/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/lib/keury/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/lib/keury/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/url_state/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/query_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/query_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/query_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/components/network_top_countries_table/columns.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/components/network_top_countries_table/columns.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/components/network_top_countries_table/columns.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/top_n/top_n.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/top_n/top_n.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/top_n/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/top_n/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/components/search_bar/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/hosts/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/hosts/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/alerts_by_category/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/ueba/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/ueba/pages/details/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/mock/index_pattern.ts"
},
{
"plugin": "timelines",
"path": "x-pack/plugins/timelines/public/mock/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/containers/with_kuery_autocompletion.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/containers/with_kuery_autocompletion.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/containers/with_source/with_source.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/containers/with_source/with_source.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/common/index_pattern_context.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/common/index_pattern_context.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/containers/source/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/components/url_state/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/columns.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_chart.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/components/expression_chart.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/common/components/search_bar/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/hosts/pages/details/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/components/network_top_countries_table/index.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/network/pages/details/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/ueba/pages/details/types.d.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/target/types/public/ueba/pages/details/types.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metric_explorer_state.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/public/pages/metrics/metrics_explorer/hooks/use_metrics_explorer_data.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/target/types/public/application/jobs/new_job/common/index_pattern_context.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_delete/use_delete_action.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/index.tsx"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/public/pages/metrics/index.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/pages/navigation/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/pages/navigation/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/network/pages/navigation/types.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/models/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/models/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/models/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/models/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/models/index_pattern.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/mock/index_pattern.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/plugins/security_solution/public/common/mock/index_pattern.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/common/dependency_mocks/index_patterns.d.ts"
},
{
"plugin": "infra",
"path": "x-pack/plugins/infra/target/types/common/dependency_mocks/index_patterns.d.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts"
},
{
"plugin": "observability",
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/editor.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/editor.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "transform",
"path": "x-pack/plugins/transform/public/app/services/es_index_service.ts"
},
{
"plugin": "transform",
"path": "x-pack/plugins/transform/public/app/services/es_index_service.ts"
},
{
"plugin": "transform",
"path": "x-pack/plugins/transform/server/routes/api/transforms.ts"
},
{
"plugin": "transform",
"path": "x-pack/plugins/transform/server/routes/api/transforms.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.test.ts"
},
{
"plugin": "ml",
"path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.test.ts"
}
],
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nType is used for identifying rollup indices, otherwise left undefined"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.getTimeField",
"type": "Function",
"tags": [],
"label": "getTimeField",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
" | undefined) | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.fieldFormatMap",
"type": "Object",
"tags": [],
"label": "fieldFormatMap",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<unknown> | undefined> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.getFormatterForField",
"type": "Function",
"tags": [],
"label": "getFormatterForField",
"description": [
"\nLook up a formatter for a given field"
],
"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"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPattern.getFormatterForField.$1",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"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"
}
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList",
"type": "Interface",
"tags": [],
"label": "IIndexPatternFieldList",
"description": [],
"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"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.add",
"type": "Function",
"tags": [],
"label": "add",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.add.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.getByName",
"type": "Function",
"tags": [],
"label": "getByName",
"description": [],
"signature": [
"(name: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.getByName.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.getByType",
"type": "Function",
"tags": [],
"label": "getByType",
"description": [],
"signature": [
"(type: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternField",
"text": "IndexPatternField"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.getByType.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.remove",
"type": "Function",
"tags": [],
"label": "remove",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.remove.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.removeAll",
"type": "Function",
"tags": [],
"label": "removeAll",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.replaceAll",
"type": "Function",
"tags": [],
"label": "replaceAll",
"description": [],
"signature": [
"(specs: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]) => void"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.replaceAll.$1",
"type": "Array",
"tags": [],
"label": "specs",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.update.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
}
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.toSpec",
"type": "Function",
"tags": [],
"label": "toSpec",
"description": [],
"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"
},
">"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.toSpec.$1.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternFieldList.toSpec.$1.options.getFormatterForField",
"type": "Function",
"tags": [],
"label": "getFormatterForField",
"description": [],
"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"
],
"path": "src/plugins/data/common/index_patterns/fields/field_list.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternsApiClient",
"type": "Interface",
"tags": [],
"label": "IIndexPatternsApiClient",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern",
"type": "Function",
"tags": [],
"label": "getFieldsForTimePattern",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptionsTimePattern",
"text": "GetFieldsOptionsTimePattern"
},
") => Promise<any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptionsTimePattern",
"text": "GetFieldsOptionsTimePattern"
}
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard",
"type": "Function",
"tags": [],
"label": "getFieldsForWildcard",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
}
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes",
"type": "Interface",
"tags": [],
"label": "IndexPatternAttributes",
"description": [
"\nInterface for an index pattern saved object"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.fields",
"type": "string",
"tags": [],
"label": "fields",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.typeMeta",
"type": "string",
"tags": [],
"label": "typeMeta",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.intervalName",
"type": "string",
"tags": [],
"label": "intervalName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.sourceFilters",
"type": "string",
"tags": [],
"label": "sourceFilters",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.fieldFormatMap",
"type": "string",
"tags": [],
"label": "fieldFormatMap",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.fieldAttrs",
"type": "string",
"tags": [],
"label": "fieldAttrs",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.runtimeFieldMap",
"type": "string",
"tags": [],
"label": "runtimeFieldMap",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternAttributes.allowNoIndex",
"type": "CompoundType",
"tags": [],
"label": "allowNoIndex",
"description": [
"\nprevents errors when index pattern exists before indices"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternExpressionType",
"type": "Interface",
"tags": [],
"label": "IndexPatternExpressionType",
"description": [],
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternExpressionType.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"index_pattern\""
],
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternExpressionType.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPatternSpec",
"text": "IndexPatternSpec"
}
],
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec",
"type": "Interface",
"tags": [],
"label": "IndexPatternSpec",
"description": [
"\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nsaved object id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nsaved object version string"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.intervalName",
"type": "string",
"tags": [
"deprecated"
],
"label": "intervalName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": true,
"references": []
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.timeFieldName",
"type": "string",
"tags": [],
"label": "timeFieldName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.sourceFilters",
"type": "Array",
"tags": [],
"label": "sourceFilters",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SourceFilter",
"text": "SourceFilter"
},
"[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.fields",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.typeMeta",
"type": "Object",
"tags": [],
"label": "typeMeta",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.TypeMeta",
"text": "TypeMeta"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.fieldFormats",
"type": "Object",
"tags": [],
"label": "fieldFormats",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.runtimeFieldMap",
"type": "Object",
"tags": [],
"label": "runtimeFieldMap",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.RuntimeField",
"text": "RuntimeField"
},
"> | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.fieldAttrs",
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternSpec.allowNoIndex",
"type": "CompoundType",
"tags": [],
"label": "allowNoIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.RuntimeField",
"type": "Interface",
"tags": [],
"label": "RuntimeField",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.RuntimeField.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\""
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.RuntimeField.script",
"type": "Object",
"tags": [],
"label": "script",
"description": [],
"signature": [
"{ source: string; } | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon",
"type": "Interface",
"tags": [],
"label": "SavedObjectsClientCommon",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [],
"signature": [
"<T = unknown>(options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SavedObjectsClientCommonFindArgs",
"text": "SavedObjectsClientCommonFindArgs"
},
") => Promise<",
"SavedObject",
"<T>[]>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.find.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.SavedObjectsClientCommonFindArgs",
"text": "SavedObjectsClientCommonFindArgs"
}
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"<T = unknown>(type: string, id: string) => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.get.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.get.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"(type: string, id: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
"SavedObject",
"<unknown>>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.update.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.update.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.update.$3",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.update.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(type: string, attributes: Record<string, any>, options: Record<string, any>) => Promise<",
"SavedObject",
"<unknown>>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.create.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.create.$2",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.create.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Record<string, any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"(type: string, id: string) => Promise<{}>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.delete.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommon.delete.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs",
"type": "Interface",
"tags": [],
"label": "SavedObjectsClientCommonFindArgs",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs.search",
"type": "string",
"tags": [],
"label": "search",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.SavedObjectsClientCommonFindArgs.searchFields",
"type": "Array",
"tags": [],
"label": "searchFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.SourceFilter",
"type": "Interface",
"tags": [],
"label": "SourceFilter",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SourceFilter.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.TypeMeta",
"type": "Interface",
"tags": [],
"label": "TypeMeta",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.TypeMeta.aggs",
"type": "Object",
"tags": [],
"label": "aggs",
"description": [],
"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"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.TypeMeta.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ rollup_index: string; } | undefined"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon",
"type": "Interface",
"tags": [],
"label": "UiSettingsCommon",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(key: string) => Promise<any>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.get.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => Promise<Record<string, any>>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.set",
"type": "Function",
"tags": [],
"label": "set",
"description": [],
"signature": [
"(key: string, value: any) => Promise<void>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.set.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.set.$2",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.remove",
"type": "Function",
"tags": [],
"label": "remove",
"description": [],
"signature": [
"(key: string) => Promise<void>"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.UiSettingsCommon.remove.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "data",
"id": "def-common.IndexPatternType",
"type": "Enum",
"tags": [],
"label": "IndexPatternType",
"description": [],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "data",
"id": "def-common.AggregationRestrictions",
"type": "Type",
"tags": [],
"label": "AggregationRestrictions",
"description": [],
"signature": [
"{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldFormatMap",
"type": "Type",
"tags": [],
"label": "FieldFormatMap",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>>; }"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.FieldSpecConflictDescriptions",
"type": "Type",
"tags": [],
"label": "FieldSpecConflictDescriptions",
"description": [],
"signature": [
"{ [x: string]: string[]; }"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternFieldMap",
"type": "Type",
"tags": [],
"label": "IndexPatternFieldMap",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"; }"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternLoadExpressionFunctionDefinition",
"type": "Type",
"tags": [],
"label": "IndexPatternLoadExpressionFunctionDefinition",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "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"
},
", ",
"Serializable",
">>"
],
"path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsContract",
"type": "Type",
"tags": [],
"label": "IndexPatternsContract",
"description": [],
"signature": [
"{ get: (id: string) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
">; delete: (indexPatternId: string) => Promise<{}>; create: (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"
},
">; find: (search: string, size?: number) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"[]>; ensureDefaultIndexPattern: ",
"EnsureDefaultIndexPattern",
"; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<",
"SavedObject",
"<",
"IndexPatternSavedObjectAttrs",
">[] | null | undefined>; getDefault: () => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
" | null>; getDefaultId: () => Promise<string | null>; setDefault: (id: string | null, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.GetFieldsOptions",
"text": "GetFieldsOptions"
},
") => Promise<any>; getFieldsForIndexPattern: (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>; refreshFields: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => Promise<void>; fieldArrayToMap: (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"
},
">; savedObjectToSpec: (savedObject: ",
"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"
},
"; createAndSave: (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"
},
">; createSavedObject: (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"
},
">; updateSavedObject: (indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
", saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"
],
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.OnError",
"type": "Type",
"tags": [],
"label": "OnError",
"description": [],
"signature": [
"(error: Error, toastInputFields: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ErrorToastOptions",
"text": "ErrorToastOptions"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.toastInputFields",
"type": "Object",
"tags": [],
"label": "toastInputFields",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ErrorToastOptions",
"text": "ErrorToastOptions"
}
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.OnNotification",
"type": "Type",
"tags": [],
"label": "OnNotification",
"description": [],
"signature": [
"(toastInputFields: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.ToastInputFields",
"text": "ToastInputFields"
},
") => void"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "data",
"id": "def-common.toastInputFields",
"type": "CompoundType",
"tags": [],
"label": "toastInputFields",
"description": [],
"signature": [
"Pick<",
"Toast",
", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.MountPoint",
"text": "MountPoint"
},
"<HTMLElement> | undefined; text?: string | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.MountPoint",
"text": "MountPoint"
},
"<HTMLElement> | undefined; }"
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "data",
"id": "def-common.RuntimeType",
"type": "Type",
"tags": [],
"label": "RuntimeType",
"description": [],
"signature": [
"\"boolean\" | \"date\" | \"keyword\" | \"long\" | \"double\" | \"ip\""
],
"path": "src/plugins/data/common/index_patterns/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "data",
"id": "def-common.RUNTIME_FIELD_TYPES",
"type": "Object",
"tags": [],
"label": "RUNTIME_FIELD_TYPES",
"description": [],
"signature": [
"readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]"
],
"path": "src/plugins/data/common/index_patterns/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink