maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/index_pattern_management.json
Stacey Gammon cecdcc538e
API docs clean up (#93508) 
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00

868 lines
29 KiB
JSON
Raw Blame History

{
"id": "indexPatternManagement",
"client": {
"classes": [
{
"id": "def-public.IndexPatternCreationConfig",
"type": "Class",
"tags": [],
"label": "IndexPatternCreationConfig",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.key",
"type": "string",
"label": "key",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 38
},
"signature": [
"\"default\""
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 40
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 41
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.showSystemIndices",
"type": "boolean",
"label": "showSystemIndices",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 42
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.httpClient",
"type": "CompoundType",
"label": "httpClient",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 43
},
"signature": [
"object | null"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.isBeta",
"type": "boolean",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 44
}
},
{
"id": "def-public.IndexPatternCreationConfig.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }",
"type": "Object",
"label": "{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 53
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 54
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.showSystemIndices",
"type": "CompoundType",
"label": "showSystemIndices",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 55
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.httpClient",
"type": "CompoundType",
"label": "httpClient",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 56
},
"signature": [
"object | null | undefined"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.isBeta",
"type": "CompoundType",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 57
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 52
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 46
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternCreationOption",
"type": "Function",
"label": "getIndexPatternCreationOption",
"signature": [
"(urlHandler: ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.UrlHandler",
"text": "UrlHandler"
},
") => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationOption",
"text": "IndexPatternCreationOption"
}
],
"description": [],
"children": [
{
"type": "Function",
"label": "urlHandler",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.UrlHandler",
"text": "UrlHandler"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 66
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 66
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternType",
"type": "Function",
"label": "getIndexPatternType",
"signature": [
"() => string | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 77
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternName",
"type": "Function",
"label": "getIndexPatternName",
"signature": [
"() => string"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 81
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIsBeta",
"type": "Function",
"label": "getIsBeta",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 85
}
},
{
"id": "def-public.IndexPatternCreationConfig.getShowSystemIndices",
"type": "Function",
"label": "getShowSystemIndices",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 89
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexTags",
"type": "Function",
"label": "getIndexTags",
"signature": [
"(indexName: string) => never[]"
],
"description": [],
"children": [
{
"type": "string",
"label": "indexName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 93
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 93
}
},
{
"id": "def-public.IndexPatternCreationConfig.checkIndicesForErrors",
"type": "Function",
"label": "checkIndicesForErrors",
"signature": [
"(indices: ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.MatchedItem",
"text": "MatchedItem"
},
"[]) => undefined"
],
"description": [],
"children": [
{
"type": "Array",
"label": "indices",
"isRequired": true,
"signature": [
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.MatchedItem",
"text": "MatchedItem"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 97
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 97
}
},
{
"id": "def-public.IndexPatternCreationConfig.getIndexPatternMappings",
"type": "Function",
"label": "getIndexPatternMappings",
"signature": [
"() => {}"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 101
}
},
{
"id": "def-public.IndexPatternCreationConfig.renderPrompt",
"type": "Function",
"label": "renderPrompt",
"signature": [
"() => null"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 105
}
},
{
"id": "def-public.IndexPatternCreationConfig.getFetchForWildcardOptions",
"type": "Function",
"label": "getFetchForWildcardOptions",
"signature": [
"() => {}"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 109
}
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternListConfig",
"type": "Class",
"tags": [],
"label": "IndexPatternListConfig",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternListConfig.key",
"type": "string",
"label": "key",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 26
},
"signature": [
"\"default\""
]
},
{
"id": "def-public.IndexPatternListConfig.getIndexPatternTags",
"type": "Function",
"label": "getIndexPatternTags",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
">, isDefault: boolean) => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternTag",
"text": "IndexPatternTag"
},
"[]"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
">"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 29
}
},
{
"type": "boolean",
"label": "isDefault",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 30
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 28
}
},
{
"id": "def-public.IndexPatternListConfig.getFieldInfo",
"type": "Function",
"label": "getFieldInfo",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
", field: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
},
") => string[]"
],
"description": [],
"children": [
{
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42
}
},
{
"type": "Object",
"label": "field",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IFieldType",
"text": "IFieldType"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 42
}
},
{
"id": "def-public.IndexPatternListConfig.areScriptedFieldsEnabled",
"type": "Function",
"label": "areScriptedFieldsEnabled",
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
},
") => boolean"
],
"description": [],
"children": [
{
"type": "Object",
"label": "indexPattern",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IIndexPattern",
"text": "IIndexPattern"
}
],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 46
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 46
}
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
"lineNumber": 25
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.IndexPatternCreationOption",
"type": "Interface",
"label": "IndexPatternCreationOption",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.testSubj",
"type": "string",
"label": "testSubj",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.onClick",
"type": "Function",
"label": "onClick",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 33
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.IndexPatternCreationOption.isBeta",
"type": "CompoundType",
"label": "isBeta",
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 34
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
"lineNumber": 29
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-public.MlCardState",
"type": "Enum",
"label": "MlCardState",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/types.ts",
"lineNumber": 42
},
"initialIsOpen": false
}
],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.IndexPatternManagementSetup",
"type": "Type",
"label": "IndexPatternManagementSetup",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"lineNumber": 32
},
"signature": [
"{ creation: { addCreationConfig: (Config: typeof ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationConfig",
"text": "IndexPatternCreationConfig"
},
") => void; }; list: { addListConfig: (Config: typeof ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternListConfig",
"text": "IndexPatternListConfig"
},
") => void; }; environment: { update: (update: Partial<",
"Environment",
">) => void; }; }"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.IndexPatternManagementStart",
"type": "Type",
"label": "IndexPatternManagementStart",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/index_pattern_management/public/plugin.ts",
"lineNumber": 34
},
"signature": [
"{ creation: { getType: (key: string | undefined) => ",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationConfig",
"text": "IndexPatternCreationConfig"
},
"; getIndexPatternCreationOptions: (urlHandler: ",
"UrlHandler",
") => Promise<",
{
"pluginId": "indexPatternManagement",
"scope": "public",
"docId": "kibIndexPatternManagementPluginApi",
"section": "def-public.IndexPatternCreationOption",
"text": "IndexPatternCreationOption"
},
"[]>; }; list: { getIndexPatternTags: (indexPattern: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.IIndexPattern",
"text": "IIndexPattern"
},
" | ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink