github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/index_management.devdocs.json

3968 lines
No EOL
141 KiB
JSON
Raw Permalink Blame History

{
"id": "indexManagement",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "indexManagement",
"id": "def-public.getIndexListUri",
"type": "Function",
"tags": [],
"label": "getIndexListUri",
"description": [],
"signature": [
"(filter?: string | undefined, includeHiddenIndices?: boolean | undefined) => string"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.getIndexListUri.$1",
"type": "string",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.getIndexListUri.$2",
"type": "CompoundType",
"tags": [],
"label": "includeHiddenIndices",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.getTemplateDetailsLink",
"type": "Function",
"tags": [],
"label": "getTemplateDetailsLink",
"description": [],
"signature": [
"(name: string, isLegacy?: boolean | undefined) => string"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.getTemplateDetailsLink.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "indexManagement",
"id": "def-public.getTemplateDetailsLink.$2",
"type": "CompoundType",
"tags": [],
"label": "isLegacy",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/public/application/services/routing.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "indexManagement",
"id": "def-public.Index",
"type": "Interface",
"tags": [],
"label": "Index",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.primary",
"type": "CompoundType",
"tags": [],
"label": "primary",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.replica",
"type": "CompoundType",
"tags": [],
"label": "replica",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.isFrozen",
"type": "boolean",
"tags": [],
"label": "isFrozen",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.aliases",
"type": "CompoundType",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.data_stream",
"type": "string",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.isRollupIndex",
"type": "CompoundType",
"tags": [],
"label": "isRollupIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.ilm",
"type": "CompoundType",
"tags": [],
"label": "ilm",
"description": [],
"signature": [
"IlmExplainLifecycleLifecycleExplain",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.isFollowerIndex",
"type": "CompoundType",
"tags": [],
"label": "isFollowerIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.health",
"type": "CompoundType",
"tags": [],
"label": "health",
"description": [],
"signature": [
"HealthStatus",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"IndicesStatsIndexMetadataState",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.uuid",
"type": "string",
"tags": [],
"label": "uuid",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.documents",
"type": "number",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.size",
"type": "string",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.primary_size",
"type": "string",
"tags": [],
"label": "primary_size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.Index.documents_deleted",
"type": "number",
"tags": [],
"label": "documents_deleted",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexMappingProps",
"type": "Interface",
"tags": [],
"label": "IndexMappingProps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexMappingProps.index",
"type": "Object",
"tags": [],
"label": "index",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.Index",
"text": "Index"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexMappingProps.showAboutMappings",
"type": "CompoundType",
"tags": [],
"label": "showAboutMappings",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexMappingProps.hasUpdateMappingsPrivilege",
"type": "CompoundType",
"tags": [],
"label": "hasUpdateMappingsPrivilege",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "indexManagement",
"id": "def-public.INDEX_MANAGEMENT_LOCATOR_ID",
"type": "string",
"tags": [],
"label": "INDEX_MANAGEMENT_LOCATOR_ID",
"description": [],
"signature": [
"\"INDEX_MANAGEMENT_LOCATOR_ID\""
],
"path": "x-pack/platform/plugins/shared/index_management/public/locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementLocatorParams",
"type": "Type",
"tags": [],
"label": "IndexManagementLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" & ({ page: \"index_list\"; filter?: string | undefined; includeHiddenIndices?: boolean | undefined; } | { page: \"data_stream_index_list\"; dataStreamName: string; } | { page: \"data_streams_details\"; dataStreamName?: string | undefined; } | { page: \"index_template\"; indexTemplate: string; } | { page: \"index_template_edit\"; indexTemplate: string; } | { page: \"index_template_clone\"; indexTemplate: string; } | { page: \"component_template\"; componentTemplate: string; } | { page: \"component_template_list\"; filter?: string | undefined; } | { page: \"edit_component_template\"; componentTemplate: string; } | { page: \"clone_component_template\"; componentTemplate: string; } | { page: \"create_component_template\"; componentTemplate: string; })"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup",
"type": "Interface",
"tags": [],
"label": "IndexManagementPluginSetup",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup.apiService",
"type": "Object",
"tags": [],
"label": "apiService",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.PublicApiServiceSetup",
"text": "PublicApiServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup.extensionsService",
"type": "Object",
"tags": [],
"label": "extensionsService",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.ExtensionsSetup",
"text": "ExtensionsSetup"
}
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup.renderIndexManagementApp",
"type": "Function",
"tags": [],
"label": "renderIndexManagementApp",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexManagementAppMountParams",
"text": "IndexManagementAppMountParams"
},
") => Promise<() => void>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup.renderIndexManagementApp.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexManagementAppMountParams",
"text": "IndexManagementAppMountParams"
}
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginSetup.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexManagementLocator",
"text": "IndexManagementLocator"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart",
"type": "Interface",
"tags": [],
"label": "IndexManagementPluginStart",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.extensionsService",
"type": "Object",
"tags": [],
"label": "extensionsService",
"description": [],
"signature": [
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.ExtensionsSetup",
"text": "ExtensionsSetup"
}
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexMappingComponent",
"type": "Function",
"tags": [],
"label": "getIndexMappingComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexMappingProps",
"text": "IndexMappingProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexMappingComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexMappingComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexSettingsComponent",
"type": "Function",
"tags": [],
"label": "getIndexSettingsComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexSettingProps",
"text": "IndexSettingProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexSettingsComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexSettingsComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getComponentTemplateFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.ComponentTemplateFlyoutProps",
"text": "ComponentTemplateFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getIndexTemplateFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexTemplateFlyoutProps",
"text": "IndexTemplateFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getDatastreamFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.DatastreamFlyoutProps",
"text": "DatastreamFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexManagement",
"id": "def-server.Dependencies",
"type": "Interface",
"tags": [],
"label": "Dependencies",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-server.Dependencies.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.SecurityPluginSetup",
"text": "SecurityPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/index_management/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Dependencies.licensing",
"type": "Object",
"tags": [],
"label": "licensing",
"description": [],
"signature": [
{
"pluginId": "licensing",
"scope": "server",
"docId": "kibLicensingPluginApi",
"section": "def-server.LicensingPluginSetup",
"text": "LicensingPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/index_management/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Dependencies.features",
"type": "Object",
"tags": [],
"label": "features",
"description": [],
"signature": [
{
"pluginId": "features",
"scope": "server",
"docId": "kibFeaturesPluginApi",
"section": "def-server.FeaturesPluginSetup",
"text": "FeaturesPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/index_management/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index",
"type": "Interface",
"tags": [],
"label": "Index",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.primary",
"type": "CompoundType",
"tags": [],
"label": "primary",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.replica",
"type": "CompoundType",
"tags": [],
"label": "replica",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.isFrozen",
"type": "boolean",
"tags": [],
"label": "isFrozen",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.aliases",
"type": "CompoundType",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.data_stream",
"type": "string",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.isRollupIndex",
"type": "CompoundType",
"tags": [],
"label": "isRollupIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.ilm",
"type": "CompoundType",
"tags": [],
"label": "ilm",
"description": [],
"signature": [
"IlmExplainLifecycleLifecycleExplain",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.isFollowerIndex",
"type": "CompoundType",
"tags": [],
"label": "isFollowerIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.health",
"type": "CompoundType",
"tags": [],
"label": "health",
"description": [],
"signature": [
"HealthStatus",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"IndicesStatsIndexMetadataState",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.uuid",
"type": "string",
"tags": [],
"label": "uuid",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.documents",
"type": "number",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.size",
"type": "string",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.primary_size",
"type": "string",
"tags": [],
"label": "primary_size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.Index.documents_deleted",
"type": "number",
"tags": [],
"label": "documents_deleted",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized",
"type": "Interface",
"tags": [],
"label": "LegacyTemplateSerialized",
"description": [
"\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.index_patterns",
"type": "Array",
"tags": [],
"label": "index_patterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.aliases",
"type": "Object",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "indexManagement",
"id": "def-server.IndexManagementConfig",
"type": "Type",
"tags": [],
"label": "IndexManagementConfig",
"description": [],
"signature": [
"{ readonly ui: Readonly<{} & { enabled: boolean; }>; readonly enableIndexActions: boolean; readonly enableLegacyTemplates: boolean; readonly dev: Readonly<{} & { enableIndexDetailsPage: boolean; enableSemanticText: boolean; }>; readonly enableSizeAndDocCount: boolean; readonly enableIndexStats: boolean; readonly enableDataStreamStats: boolean; readonly editableIndexSettings: \"all\" | \"limited\"; readonly enableMappingsSourceFieldSection: boolean; readonly enableTogglingDataRetention: boolean; readonly enableProjectLevelRetentionChecks: boolean; }"
],
"path": "x-pack/platform/plugins/shared/index_management/server/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "indexManagement",
"id": "def-server.IndexManagementPluginSetup",
"type": "Interface",
"tags": [],
"label": "IndexManagementPluginSetup",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-server.IndexManagementPluginSetup.indexDataEnricher",
"type": "Object",
"tags": [],
"label": "indexDataEnricher",
"description": [],
"signature": [
"{ add: (enricher: ",
"Enricher",
") => void; }"
],
"path": "x-pack/platform/plugins/shared/index_management/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "indexManagement",
"id": "def-common.getTemplateParameter",
"type": "Function",
"tags": [],
"label": "getTemplateParameter",
"description": [],
"signature": [
"(template: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.LegacyTemplateSerialized",
"text": "LegacyTemplateSerialized"
},
" | ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.TemplateSerialized",
"text": "TemplateSerialized"
},
", setting: \"settings\" | \"mappings\" | \"aliases\") => ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/lib/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.getTemplateParameter.$1",
"type": "CompoundType",
"tags": [],
"label": "template",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.LegacyTemplateSerialized",
"text": "LegacyTemplateSerialized"
},
" | ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.TemplateSerialized",
"text": "TemplateSerialized"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/lib/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "indexManagement",
"id": "def-common.getTemplateParameter.$2",
"type": "CompoundType",
"tags": [],
"label": "setting",
"description": [],
"signature": [
"\"settings\" | \"mappings\" | \"aliases\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/lib/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.splitSizeAndUnits",
"type": "Function",
"tags": [],
"label": "splitSizeAndUnits",
"description": [],
"signature": [
"(field: string) => { size: string; unit: string; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/lib/data_stream_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.splitSizeAndUnits.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/index_management/common/lib/data_stream_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "indexManagement",
"id": "def-common.Aliases",
"type": "Interface",
"tags": [],
"label": "Aliases",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/aliases.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.Aliases.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: any",
"description": [],
"signature": [
"[key: string]: any"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/aliases.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDatastreams",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateDatastreams",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDatastreams.data_streams",
"type": "Array",
"tags": [],
"label": "data_streams",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateDeserialized",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.ComponentTemplateDeserialized",
"text": "ComponentTemplateDeserialized"
},
" extends ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.ComponentTemplateSerialized",
"text": "ComponentTemplateSerialized"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized._kbnMeta",
"type": "Object",
"tags": [],
"label": "_kbnMeta",
"description": [],
"signature": [
"{ usedBy: string[]; isManaged: boolean; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateFromEs",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateFromEs",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateFromEs.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateFromEs.component_template",
"type": "Object",
"tags": [],
"label": "component_template",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.ComponentTemplateSerialized",
"text": "ComponentTemplateSerialized"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateListItem",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.usedBy",
"type": "Array",
"tags": [],
"label": "usedBy",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.hasMappings",
"type": "boolean",
"tags": [],
"label": "hasMappings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.hasAliases",
"type": "boolean",
"tags": [],
"label": "hasAliases",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.hasSettings",
"type": "boolean",
"tags": [],
"label": "hasSettings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.isManaged",
"type": "boolean",
"tags": [],
"label": "isManaged",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateMeta",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateMeta",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateMeta.managed",
"type": "boolean",
"tags": [],
"label": "managed",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateMeta.managed_by",
"type": "string",
"tags": [],
"label": "managed_by",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateMeta.package",
"type": "Object",
"tags": [],
"label": "package",
"description": [],
"signature": [
"{ name: string; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateSerialized",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized.template",
"type": "Object",
"tags": [],
"label": "template",
"description": [],
"signature": [
"{ settings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
},
" | undefined; aliases?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined; mappings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
" | undefined; lifecycle?: (",
"IndicesDataStreamLifecycleWithRollover",
" & { enabled?: boolean | undefined; effective_retention?: string | undefined; retention_determined_by?: string | undefined; globalMaxRetention?: string | undefined; }) | undefined; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized.lifecycle",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.DataRetention",
"text": "DataRetention"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataRetention",
"type": "Interface",
"tags": [],
"label": "DataRetention",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.DataRetention.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataRetention.infiniteDataRetention",
"type": "CompoundType",
"tags": [],
"label": "infiniteDataRetention",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataRetention.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataRetention.unit",
"type": "string",
"tags": [],
"label": "unit",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream",
"type": "Interface",
"tags": [],
"label": "DataStream",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.timeStampField",
"type": "Object",
"tags": [],
"label": "timeStampField",
"description": [],
"signature": [
"TimestampFieldFromEs"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.DataStreamIndex",
"text": "DataStreamIndex"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.generation",
"type": "number",
"tags": [],
"label": "generation",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.health",
"type": "CompoundType",
"tags": [],
"label": "health",
"description": [],
"signature": [
"\"green\" | \"yellow\" | \"red\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.indexTemplateName",
"type": "string",
"tags": [],
"label": "indexTemplateName",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.ilmPolicyName",
"type": "string",
"tags": [],
"label": "ilmPolicyName",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.storageSize",
"type": "CompoundType",
"tags": [],
"label": "storageSize",
"description": [],
"signature": [
"ByteSize",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.storageSizeBytes",
"type": "number",
"tags": [],
"label": "storageSizeBytes",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.maxTimeStamp",
"type": "number",
"tags": [],
"label": "maxTimeStamp",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.meteringStorageSizeBytes",
"type": "number",
"tags": [],
"label": "meteringStorageSizeBytes",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.meteringStorageSize",
"type": "string",
"tags": [],
"label": "meteringStorageSize",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.meteringDocsCount",
"type": "number",
"tags": [],
"label": "meteringDocsCount",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"Metadata",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
"PrivilegesFromEs"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.nextGenerationManagedBy",
"type": "string",
"tags": [],
"label": "nextGenerationManagedBy",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.lifecycle",
"type": "CompoundType",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
"(",
"IndicesDataStreamLifecycleWithRollover",
" & { enabled?: boolean | undefined; effective_retention?: string | undefined; retention_determined_by?: string | undefined; globalMaxRetention?: string | undefined; }) | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.indexMode",
"type": "CompoundType",
"tags": [],
"label": "indexMode",
"description": [],
"signature": [
"\"standard\" | \"time_series\" | \"lookup\" | \"logsdb\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStreamIndex",
"type": "Interface",
"tags": [],
"label": "DataStreamIndex",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStreamIndex.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStreamIndex.uuid",
"type": "string",
"tags": [],
"label": "uuid",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStreamIndex.preferILM",
"type": "boolean",
"tags": [],
"label": "preferILM",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStreamIndex.managedBy",
"type": "string",
"tags": [],
"label": "managedBy",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs",
"type": "Interface",
"tags": [],
"label": "EnhancedDataStreamFromEs",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.EnhancedDataStreamFromEs",
"text": "EnhancedDataStreamFromEs"
},
" extends ",
"IndicesDataStream"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.global_max_retention",
"type": "string",
"tags": [],
"label": "global_max_retention",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.store_size",
"type": "CompoundType",
"tags": [],
"label": "store_size",
"description": [],
"signature": [
"ByteSize",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.store_size_bytes",
"type": "number",
"tags": [],
"label": "store_size_bytes",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.maximum_timestamp",
"type": "number",
"tags": [],
"label": "maximum_timestamp",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.metering_size_in_bytes",
"type": "number",
"tags": [],
"label": "metering_size_in_bytes",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.metering_doc_count",
"type": "number",
"tags": [],
"label": "metering_doc_count",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
"IndicesDataStreamIndex",
"[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
"{ delete_index: boolean; manage_data_stream_lifecycle: boolean; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.EnhancedDataStreamFromEs.index_mode",
"type": "CompoundType",
"tags": [],
"label": "index_mode",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldFromIndicesRequest",
"type": "Interface",
"tags": [],
"label": "FieldFromIndicesRequest",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldFromIndicesRequest.commonFields",
"type": "Array",
"tags": [],
"label": "commonFields",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.FieldItem",
"text": "FieldItem"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldFromIndicesRequest.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexWithFields",
"text": "IndexWithFields"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldItem",
"type": "Interface",
"tags": [],
"label": "FieldItem",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldItem.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.FieldItem.normalizedType",
"type": "string",
"tags": [],
"label": "normalizedType",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index",
"type": "Interface",
"tags": [],
"label": "Index",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.primary",
"type": "CompoundType",
"tags": [],
"label": "primary",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.replica",
"type": "CompoundType",
"tags": [],
"label": "replica",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.isFrozen",
"type": "boolean",
"tags": [],
"label": "isFrozen",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.hidden",
"type": "boolean",
"tags": [],
"label": "hidden",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.aliases",
"type": "CompoundType",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.data_stream",
"type": "string",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.isRollupIndex",
"type": "CompoundType",
"tags": [],
"label": "isRollupIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.ilm",
"type": "CompoundType",
"tags": [],
"label": "ilm",
"description": [],
"signature": [
"IlmExplainLifecycleLifecycleExplain",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.isFollowerIndex",
"type": "CompoundType",
"tags": [],
"label": "isFollowerIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.health",
"type": "CompoundType",
"tags": [],
"label": "health",
"description": [],
"signature": [
"HealthStatus",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"IndicesStatsIndexMetadataState",
" | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.uuid",
"type": "string",
"tags": [],
"label": "uuid",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.documents",
"type": "number",
"tags": [],
"label": "documents",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.size",
"type": "string",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.primary_size",
"type": "string",
"tags": [],
"label": "primary_size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Index.documents_deleted",
"type": "number",
"tags": [],
"label": "documents_deleted",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettings",
"type": "Interface",
"tags": [],
"label": "IndexSettings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettings.index",
"type": "Object",
"tags": [],
"label": "index",
"description": [],
"signature": [
"IndicesIndexSettingsKeys",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettings.analysis",
"type": "Object",
"tags": [],
"label": "analysis",
"description": [],
"signature": [
"AnalysisModule | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettings.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: any",
"description": [],
"signature": [
"[key: string]: any"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse",
"type": "Interface",
"tags": [],
"label": "IndexSettingsResponse",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse.defaults",
"type": "Object",
"tags": [],
"label": "defaults",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexWithFields",
"type": "Interface",
"tags": [],
"label": "IndexWithFields",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexWithFields.index",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexWithFields.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.FieldItem",
"text": "FieldItem"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/enrich_policies.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized",
"type": "Interface",
"tags": [],
"label": "LegacyTemplateSerialized",
"description": [
"\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.index_patterns",
"type": "Array",
"tags": [],
"label": "index_patterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.aliases",
"type": "Object",
"tags": [],
"label": "aliases",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Mappings",
"type": "Interface",
"tags": [],
"label": "Mappings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.Mappings.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: any",
"description": [],
"signature": [
"[key: string]: any"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/mappings.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized",
"type": "Interface",
"tags": [],
"label": "TemplateDeserialized",
"description": [
"\nTemplateDeserialized is the format the UI will be working with,\nregardless if we are loading the new format (composable) index template,\nor the legacy one. Serialization is done server side."
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.template",
"type": "Object",
"tags": [],
"label": "template",
"description": [],
"signature": [
"{ settings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
},
" | undefined; aliases?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined; mappings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
" | undefined; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.lifecycle",
"type": "Object",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.DataRetention",
"text": "DataRetention"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.composedOf",
"type": "Array",
"tags": [],
"label": "composedOf",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.ignoreMissingComponentTemplates",
"type": "Array",
"tags": [],
"label": "ignoreMissingComponentTemplates",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.priority",
"type": "number",
"tags": [],
"label": "priority",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.allowAutoCreate",
"type": "string",
"tags": [],
"label": "allowAutoCreate",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.indexMode",
"type": "CompoundType",
"tags": [],
"label": "indexMode",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexMode",
"text": "IndexMode"
},
" | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.ilmPolicy",
"type": "Object",
"tags": [],
"label": "ilmPolicy",
"description": [],
"signature": [
"{ name: string; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.dataStream",
"type": "Object",
"tags": [],
"label": "dataStream",
"description": [],
"signature": [
"{ [key: string]: any; hidden?: boolean | undefined; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized._kbnMeta",
"type": "Object",
"tags": [],
"label": "_kbnMeta",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.TemplateType",
"text": "TemplateType"
},
"; hasDatastream: boolean; isLegacy?: boolean | undefined; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateFromEs",
"type": "Interface",
"tags": [],
"label": "TemplateFromEs",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateFromEs.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateFromEs.index_template",
"type": "Object",
"tags": [],
"label": "index_template",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.TemplateSerialized",
"text": "TemplateSerialized"
}
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem",
"type": "Interface",
"tags": [],
"label": "TemplateListItem",
"description": [
"\nInterface for the template list in our UI table\nwe don't include the mappings, settings and aliases\nto reduce the payload size sent back to the client."
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.indexPatterns",
"type": "Array",
"tags": [],
"label": "indexPatterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.priority",
"type": "number",
"tags": [],
"label": "priority",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.hasSettings",
"type": "boolean",
"tags": [],
"label": "hasSettings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.hasAliases",
"type": "boolean",
"tags": [],
"label": "hasAliases",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.hasMappings",
"type": "boolean",
"tags": [],
"label": "hasMappings",
"description": [],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.ilmPolicy",
"type": "Object",
"tags": [],
"label": "ilmPolicy",
"description": [],
"signature": [
"{ name: string; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.composedOf",
"type": "Array",
"tags": [],
"label": "composedOf",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem._kbnMeta",
"type": "Object",
"tags": [],
"label": "_kbnMeta",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.TemplateType",
"text": "TemplateType"
},
"; hasDatastream: boolean; isLegacy?: boolean | undefined; }"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized",
"type": "Interface",
"tags": [],
"label": "TemplateSerialized",
"description": [
"\nIndex template format from Elasticsearch"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.index_patterns",
"type": "Array",
"tags": [],
"label": "index_patterns",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.template",
"type": "Object",
"tags": [],
"label": "template",
"description": [],
"signature": [
"{ settings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
},
" | undefined; aliases?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Aliases",
"text": "Aliases"
},
" | undefined; mappings?: ",
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
" | undefined; lifecycle?: (",
"IndicesDataStreamLifecycleWithRollover",
" & { enabled?: boolean | undefined; effective_retention?: string | undefined; retention_determined_by?: string | undefined; globalMaxRetention?: string | undefined; }) | undefined; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.composed_of",
"type": "Array",
"tags": [],
"label": "composed_of",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.ignore_missing_component_templates",
"type": "Array",
"tags": [],
"label": "ignore_missing_component_templates",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.priority",
"type": "number",
"tags": [],
"label": "priority",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.data_stream",
"type": "Object",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"{} | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.allow_auto_create",
"type": "CompoundType",
"tags": [],
"label": "allow_auto_create",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "indexManagement",
"id": "def-common.API_BASE_PATH",
"type": "string",
"tags": [],
"label": "API_BASE_PATH",
"description": [],
"signature": [
"\"/api/index_management\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/constants/api_base_path.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.BASE_PATH",
"type": "string",
"tags": [],
"label": "BASE_PATH",
"description": [],
"signature": [
"\"/management/data/index_management/\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/constants/base_path.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.Health",
"type": "Type",
"tags": [],
"label": "Health",
"description": [],
"signature": [
"\"green\" | \"yellow\" | \"red\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexMode",
"type": "Type",
"tags": [],
"label": "IndexMode",
"description": [],
"signature": [
"\"standard\" | \"time_series\" | \"lookup\" | \"logsdb\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.INTERNAL_API_BASE_PATH",
"type": "string",
"tags": [],
"label": "INTERNAL_API_BASE_PATH",
"description": [],
"signature": [
"\"/internal/index_management\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/constants/api_base_path.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.MAJOR_VERSION",
"type": "string",
"tags": [],
"label": "MAJOR_VERSION",
"description": [],
"signature": [
"\"8.5.0\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/constants/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateType",
"type": "Type",
"tags": [],
"label": "TemplateType",
"description": [],
"signature": [
"\"default\" | \"managed\" | \"system\" | \"cloudManaged\""
],
"path": "x-pack/platform/plugins/shared/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink