* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
914 lines
36 KiB
JSON
914 lines
36 KiB
JSON
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L38"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L40"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L41"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L42"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L43"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L44"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L53"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L54"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L55"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L56"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L57"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L52"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L46"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 66,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L77"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L81"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L85"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L89"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 97,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L101"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L105"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L109"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L37"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L26"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L29"
|
|
}
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"label": "isDefault",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L28"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/list/config.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L25"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L30"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L31"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L32"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L33"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L34"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_management/public/service/creation/config.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L29"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/types.ts#L42"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L32"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L34"
|
|
},
|
|
"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": []
|
|
}
|
|
} |