{ "id": "indexManagement", "client": { "classes": [], "functions": [ { "id": "def-public.getIndexListUri", "type": "Function", "children": [ { "type": "string", "label": "filter", "isRequired": false, "signature": [ "string | undefined" ], "description": [], "source": { "path": "x-pack/plugins/index_management/public/application/services/routing.ts", "lineNumber": 38 } }, { "type": "CompoundType", "label": "includeHiddenIndices", "isRequired": false, "signature": [ "boolean | undefined" ], "description": [], "source": { "path": "x-pack/plugins/index_management/public/application/services/routing.ts", "lineNumber": 38 } } ], "signature": [ "(filter?: string | undefined, includeHiddenIndices?: boolean | undefined) => string" ], "description": [], "label": "getIndexListUri", "source": { "path": "x-pack/plugins/index_management/public/application/services/routing.ts", "lineNumber": 38 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.Index", "type": "Interface", "label": "Index", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Index.health", "type": "string", "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-public.Index.status", "type": "string", "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 } }, { "tags": [], "id": "def-public.Index.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-public.Index.uuid", "type": "string", "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 } }, { "tags": [], "id": "def-public.Index.primary", "type": "string", "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-public.Index.replica", "type": "string", "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 } }, { "tags": [], "id": "def-public.Index.documents", "type": "Any", "label": "documents", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.Index.size", "type": "Any", "label": "size", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.Index.isFrozen", "type": "boolean", "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 } }, { "tags": [], "id": "def-public.Index.aliases", "type": "CompoundType", "label": "aliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, "signature": [ "string | string[]" ] }, { "tags": [], "id": "def-public.Index.data_stream", "type": "string", "label": "data_stream", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, "signature": [ "string | undefined" ] }, { "id": "def-public.Index.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-public.IndexManagementPluginSetup", "type": "Interface", "label": "IndexManagementPluginSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.IndexManagementPluginSetup.extensionsService", "type": "Object", "label": "extensionsService", "description": [], "source": { "path": "x-pack/plugins/index_management/public/types.ts", "lineNumber": 14 }, "signature": [ { "pluginId": "indexManagement", "scope": "public", "docId": "kibIndexManagementPluginApi", "section": "def-public.ExtensionsSetup", "text": "ExtensionsSetup" } ] } ], "source": { "path": "x-pack/plugins/index_management/public/types.ts", "lineNumber": 13 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [ { "id": "def-server.Dependencies", "type": "Interface", "label": "Dependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.Dependencies.security", "type": "Object", "label": "security", "description": [], "source": { "path": "x-pack/plugins/index_management/server/types.ts", "lineNumber": 21 }, "signature": [ { "pluginId": "security", "scope": "server", "docId": "kibSecurityPluginApi", "section": "def-server.SecurityPluginSetup", "text": "SecurityPluginSetup" } ] }, { "tags": [], "id": "def-server.Dependencies.licensing", "type": "Object", "label": "licensing", "description": [], "source": { "path": "x-pack/plugins/index_management/server/types.ts", "lineNumber": 22 }, "signature": [ { "pluginId": "licensing", "scope": "server", "docId": "kibLicensingPluginApi", "section": "def-server.LicensingPluginSetup", "text": "LicensingPluginSetup" } ] }, { "tags": [], "id": "def-server.Dependencies.features", "type": "Object", "label": "features", "description": [], "source": { "path": "x-pack/plugins/index_management/server/types.ts", "lineNumber": 23 }, "signature": [ { "pluginId": "features", "scope": "server", "docId": "kibFeaturesPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ] } ], "source": { "path": "x-pack/plugins/index_management/server/types.ts", "lineNumber": 20 }, "initialIsOpen": false }, { "id": "def-server.Index", "type": "Interface", "label": "Index", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.Index.health", "type": "string", "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-server.Index.status", "type": "string", "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 } }, { "tags": [], "id": "def-server.Index.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-server.Index.uuid", "type": "string", "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 } }, { "tags": [], "id": "def-server.Index.primary", "type": "string", "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-server.Index.replica", "type": "string", "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 } }, { "tags": [], "id": "def-server.Index.documents", "type": "Any", "label": "documents", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, "signature": [ "any" ] }, { "tags": [], "id": "def-server.Index.size", "type": "Any", "label": "size", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, "signature": [ "any" ] }, { "tags": [], "id": "def-server.Index.isFrozen", "type": "boolean", "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 } }, { "tags": [], "id": "def-server.Index.aliases", "type": "CompoundType", "label": "aliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, "signature": [ "string | string[]" ] }, { "tags": [], "id": "def-server.Index.data_stream", "type": "string", "label": "data_stream", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, "signature": [ "string | undefined" ] }, { "id": "def-server.Index.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-server.LegacyTemplateSerialized", "type": "Interface", "label": "LegacyTemplateSerialized", "description": [ "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" ], "tags": [], "children": [ { "tags": [], "id": "def-server.LegacyTemplateSerialized.index_patterns", "type": "Array", "label": "index_patterns", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 100 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-server.LegacyTemplateSerialized.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 101 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-server.LegacyTemplateSerialized.settings", "type": "Object", "label": "settings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 102 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.IndexSettings", "text": "IndexSettings" }, " | undefined" ] }, { "tags": [], "id": "def-server.LegacyTemplateSerialized.aliases", "type": "Object", "label": "aliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 103 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.Aliases", "text": "Aliases" }, " | undefined" ] }, { "tags": [], "id": "def-server.LegacyTemplateSerialized.mappings", "type": "Object", "label": "mappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 104 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.Mappings", "text": "Mappings" }, " | undefined" ] }, { "tags": [], "id": "def-server.LegacyTemplateSerialized.order", "type": "number", "label": "order", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 105 }, "signature": [ "number | undefined" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 99 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-server.IndexManagementConfig", "type": "Type", "label": "IndexManagementConfig", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/server/config.ts", "lineNumber": 14 }, "signature": [ "{ readonly enabled: boolean; }" ], "initialIsOpen": false } ], "objects": [], "setup": { "id": "def-server.IndexManagementPluginSetup", "type": "Interface", "label": "IndexManagementPluginSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.IndexManagementPluginSetup.indexDataEnricher", "type": "Object", "label": "indexDataEnricher", "description": [], "source": { "path": "x-pack/plugins/index_management/server/plugin.ts", "lineNumber": 26 }, "signature": [ "{ add: (enricher: ", { "pluginId": "indexManagement", "scope": "server", "docId": "kibIndexManagementPluginApi", "section": "def-server.Enricher", "text": "Enricher" }, ") => void; }" ] } ], "source": { "path": "x-pack/plugins/index_management/server/plugin.ts", "lineNumber": 25 }, "lifecycle": "setup", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "id": "def-common.getTemplateParameter", "type": "Function", "children": [ { "type": "CompoundType", "label": "template", "isRequired": true, "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" } ], "description": [], "source": { "path": "x-pack/plugins/index_management/common/lib/utils.ts", "lineNumber": 22 } }, { "type": "CompoundType", "label": "setting", "isRequired": true, "signature": [ "\"aliases\" | \"settings\" | \"mappings\"" ], "description": [], "source": { "path": "x-pack/plugins/index_management/common/lib/utils.ts", "lineNumber": 23 } } ], "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: \"aliases\" | \"settings\" | \"mappings\") => ", { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.Aliases", "text": "Aliases" }, " | undefined" ], "description": [], "label": "getTemplateParameter", "source": { "path": "x-pack/plugins/index_management/common/lib/utils.ts", "lineNumber": 21 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.Aliases", "type": "Interface", "label": "Aliases", "description": [], "tags": [], "children": [ { "id": "def-common.Aliases.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/aliases.ts", "lineNumber": 9 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/aliases.ts", "lineNumber": 8 }, "initialIsOpen": false }, { "id": "def-common.ComponentTemplateDeserialized", "type": "Interface", "label": "ComponentTemplateDeserialized", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ComponentTemplateDeserialized.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 23 } }, { "tags": [], "id": "def-common.ComponentTemplateDeserialized._kbnMeta", "type": "Object", "label": "_kbnMeta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 24 }, "signature": [ "{ usedBy: string[]; isManaged: boolean; }" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 22 }, "initialIsOpen": false }, { "id": "def-common.ComponentTemplateFromEs", "type": "Interface", "label": "ComponentTemplateFromEs", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ComponentTemplateFromEs.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 31 } }, { "tags": [], "id": "def-common.ComponentTemplateFromEs.component_template", "type": "Object", "label": "component_template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 32 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.ComponentTemplateSerialized", "text": "ComponentTemplateSerialized" } ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-common.ComponentTemplateListItem", "type": "Interface", "label": "ComponentTemplateListItem", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ComponentTemplateListItem.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 36 } }, { "tags": [], "id": "def-common.ComponentTemplateListItem.usedBy", "type": "Array", "label": "usedBy", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 37 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.ComponentTemplateListItem.hasMappings", "type": "boolean", "label": "hasMappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 38 } }, { "tags": [], "id": "def-common.ComponentTemplateListItem.hasAliases", "type": "boolean", "label": "hasAliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 39 } }, { "tags": [], "id": "def-common.ComponentTemplateListItem.hasSettings", "type": "boolean", "label": "hasSettings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 40 } }, { "tags": [], "id": "def-common.ComponentTemplateListItem.isManaged", "type": "boolean", "label": "isManaged", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 41 } } ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 35 }, "initialIsOpen": false }, { "id": "def-common.ComponentTemplateSerialized", "type": "Interface", "label": "ComponentTemplateSerialized", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.ComponentTemplateSerialized.template", "type": "Object", "label": "template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 13 }, "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; }" ] }, { "tags": [], "id": "def-common.ComponentTemplateSerialized.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 18 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.ComponentTemplateSerialized._meta", "type": "Object", "label": "_meta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 19 }, "signature": [ "{ [key: string]: any; } | undefined" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/component_templates.ts", "lineNumber": 12 }, "initialIsOpen": false }, { "id": "def-common.DataStream", "type": "Interface", "label": "DataStream", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DataStream.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 54 } }, { "tags": [], "id": "def-common.DataStream.timeStampField", "type": "Object", "label": "timeStampField", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 55 }, "signature": [ "TimestampFieldFromEs" ] }, { "tags": [], "id": "def-common.DataStream.indices", "type": "Array", "label": "indices", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 56 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.DataStreamIndex", "text": "DataStreamIndex" }, "[]" ] }, { "tags": [], "id": "def-common.DataStream.generation", "type": "number", "label": "generation", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-common.DataStream.health", "type": "CompoundType", "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 58 }, "signature": [ "ClusterStatus" ] }, { "tags": [], "id": "def-common.DataStream.indexTemplateName", "type": "string", "label": "indexTemplateName", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-common.DataStream.ilmPolicyName", "type": "string", "label": "ilmPolicyName", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 60 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.DataStream.storageSize", "type": "string", "label": "storageSize", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 61 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.DataStream.storageSizeBytes", "type": "number", "label": "storageSizeBytes", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 62 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.DataStream.maxTimeStamp", "type": "number", "label": "maxTimeStamp", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 63 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.DataStream._meta", "type": "Object", "label": "_meta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 64 }, "signature": [ "MetaFromEs | undefined" ] }, { "tags": [], "id": "def-common.DataStream.privileges", "type": "Object", "label": "privileges", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 65 }, "signature": [ "PrivilegesFromEs" ] }, { "tags": [], "id": "def-common.DataStream.hidden", "type": "boolean", "label": "hidden", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 66 } } ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 53 }, "initialIsOpen": false }, { "id": "def-common.DataStreamFromEs", "type": "Interface", "label": "DataStreamFromEs", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DataStreamFromEs.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 31 } }, { "tags": [], "id": "def-common.DataStreamFromEs.timestamp_field", "type": "Object", "label": "timestamp_field", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 32 }, "signature": [ "TimestampFieldFromEs" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.indices", "type": "Array", "label": "indices", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 33 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.DataStreamIndexFromEs", "text": "DataStreamIndexFromEs" }, "[]" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.generation", "type": "number", "label": "generation", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 34 } }, { "tags": [], "id": "def-common.DataStreamFromEs._meta", "type": "Object", "label": "_meta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 35 }, "signature": [ "MetaFromEs | undefined" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.status", "type": "CompoundType", "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 36 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.HealthFromEs", "text": "HealthFromEs" } ] }, { "tags": [], "id": "def-common.DataStreamFromEs.template", "type": "string", "label": "template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 37 } }, { "tags": [], "id": "def-common.DataStreamFromEs.ilm_policy", "type": "string", "label": "ilm_policy", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 38 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.store_size", "type": "string", "label": "store_size", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 39 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.store_size_bytes", "type": "number", "label": "store_size_bytes", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 40 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.maximum_timestamp", "type": "number", "label": "maximum_timestamp", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 41 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.privileges", "type": "Object", "label": "privileges", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 42 }, "signature": [ "PrivilegesFromEs" ] }, { "tags": [], "id": "def-common.DataStreamFromEs.hidden", "type": "boolean", "label": "hidden", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 43 } } ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-common.DataStreamIndex", "type": "Interface", "label": "DataStreamIndex", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.DataStreamIndex.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 70 } }, { "tags": [], "id": "def-common.DataStreamIndex.uuid", "type": "string", "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 71 } } ], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 69 }, "initialIsOpen": false }, { "id": "def-common.Index", "type": "Interface", "label": "Index", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.Index.health", "type": "string", "label": "health", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-common.Index.status", "type": "string", "label": "status", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 56 } }, { "tags": [], "id": "def-common.Index.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-common.Index.uuid", "type": "string", "label": "uuid", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 58 } }, { "tags": [], "id": "def-common.Index.primary", "type": "string", "label": "primary", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 59 } }, { "tags": [], "id": "def-common.Index.replica", "type": "string", "label": "replica", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 60 } }, { "tags": [], "id": "def-common.Index.documents", "type": "Any", "label": "documents", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 61 }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.Index.size", "type": "Any", "label": "size", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 62 }, "signature": [ "any" ] }, { "tags": [], "id": "def-common.Index.isFrozen", "type": "boolean", "label": "isFrozen", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 63 } }, { "tags": [], "id": "def-common.Index.aliases", "type": "CompoundType", "label": "aliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 64 }, "signature": [ "string | string[]" ] }, { "tags": [], "id": "def-common.Index.data_stream", "type": "string", "label": "data_stream", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 65 }, "signature": [ "string | undefined" ] }, { "id": "def-common.Index.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 66 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-common.IndexSettings", "type": "Interface", "label": "IndexSettings", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.IndexSettings.index", "type": "Object", "label": "index", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 49 }, "signature": [ "Partial | undefined" ] }, { "tags": [], "id": "def-common.IndexSettings.analysis", "type": "Object", "label": "analysis", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 50 }, "signature": [ "AnalysisModule | undefined" ] }, { "id": "def-common.IndexSettings.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 51 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/indices.ts", "lineNumber": 48 }, "initialIsOpen": false }, { "id": "def-common.LegacyTemplateSerialized", "type": "Interface", "label": "LegacyTemplateSerialized", "description": [ "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" ], "tags": [], "children": [ { "tags": [], "id": "def-common.LegacyTemplateSerialized.index_patterns", "type": "Array", "label": "index_patterns", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 100 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.LegacyTemplateSerialized.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 101 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.LegacyTemplateSerialized.settings", "type": "Object", "label": "settings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 102 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.IndexSettings", "text": "IndexSettings" }, " | undefined" ] }, { "tags": [], "id": "def-common.LegacyTemplateSerialized.aliases", "type": "Object", "label": "aliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 103 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.Aliases", "text": "Aliases" }, " | undefined" ] }, { "tags": [], "id": "def-common.LegacyTemplateSerialized.mappings", "type": "Object", "label": "mappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 104 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.Mappings", "text": "Mappings" }, " | undefined" ] }, { "tags": [], "id": "def-common.LegacyTemplateSerialized.order", "type": "number", "label": "order", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 105 }, "signature": [ "number | undefined" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 99 }, "initialIsOpen": false }, { "id": "def-common.Mappings", "type": "Interface", "label": "Mappings", "description": [], "tags": [], "children": [ { "id": "def-common.Mappings.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/mappings.ts", "lineNumber": 11 }, "signature": [ "any" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/mappings.ts", "lineNumber": 10 }, "initialIsOpen": false }, { "id": "def-common.TemplateDeserialized", "type": "Interface", "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." ], "tags": [], "children": [ { "tags": [], "id": "def-common.TemplateDeserialized.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 35 } }, { "tags": [], "id": "def-common.TemplateDeserialized.indexPatterns", "type": "Array", "label": "indexPatterns", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 36 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.template", "type": "Object", "label": "template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 37 }, "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" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.composedOf", "type": "Array", "label": "composedOf", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 42 }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 43 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.priority", "type": "number", "label": "priority", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 44 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.order", "type": "number", "label": "order", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 45 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.ilmPolicy", "type": "Object", "label": "ilmPolicy", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 46 }, "signature": [ "{ name: string; } | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized._meta", "type": "Object", "label": "_meta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 49 }, "signature": [ "{ [key: string]: any; } | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized.dataStream", "type": "Object", "label": "dataStream", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 51 }, "signature": [ "{ [key: string]: any; hidden?: boolean | undefined; } | undefined" ] }, { "tags": [], "id": "def-common.TemplateDeserialized._kbnMeta", "type": "Object", "label": "_kbnMeta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 55 }, "signature": [ "{ type: ", { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.TemplateType", "text": "TemplateType" }, "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-common.TemplateFromEs", "type": "Interface", "label": "TemplateFromEs", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.TemplateFromEs.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 65 } }, { "tags": [], "id": "def-common.TemplateFromEs.index_template", "type": "Object", "label": "index_template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 66 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.TemplateSerialized", "text": "TemplateSerialized" } ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 64 }, "initialIsOpen": false }, { "id": "def-common.TemplateListItem", "type": "Interface", "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." ], "tags": [], "children": [ { "tags": [], "id": "def-common.TemplateListItem.name", "type": "string", "label": "name", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 75 } }, { "tags": [], "id": "def-common.TemplateListItem.indexPatterns", "type": "Array", "label": "indexPatterns", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 76 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.TemplateListItem.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 77 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateListItem.order", "type": "number", "label": "order", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 78 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateListItem.priority", "type": "number", "label": "priority", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 79 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateListItem.hasSettings", "type": "boolean", "label": "hasSettings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 80 } }, { "tags": [], "id": "def-common.TemplateListItem.hasAliases", "type": "boolean", "label": "hasAliases", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 81 } }, { "tags": [], "id": "def-common.TemplateListItem.hasMappings", "type": "boolean", "label": "hasMappings", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 82 } }, { "tags": [], "id": "def-common.TemplateListItem.ilmPolicy", "type": "Object", "label": "ilmPolicy", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 83 }, "signature": [ "{ name: string; } | undefined" ] }, { "tags": [], "id": "def-common.TemplateListItem._kbnMeta", "type": "Object", "label": "_kbnMeta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 86 }, "signature": [ "{ type: ", { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", "section": "def-common.TemplateType", "text": "TemplateType" }, "; hasDatastream: boolean; isLegacy?: boolean | undefined; }" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 74 }, "initialIsOpen": false }, { "id": "def-common.TemplateSerialized", "type": "Interface", "label": "TemplateSerialized", "description": [ "\nIndex template format from Elasticsearch" ], "tags": [], "children": [ { "tags": [], "id": "def-common.TemplateSerialized.index_patterns", "type": "Array", "label": "index_patterns", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 16 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-common.TemplateSerialized.template", "type": "Object", "label": "template", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 17 }, "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" ] }, { "tags": [], "id": "def-common.TemplateSerialized.composed_of", "type": "Array", "label": "composed_of", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 22 }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-common.TemplateSerialized.version", "type": "number", "label": "version", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 23 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateSerialized.priority", "type": "number", "label": "priority", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 24 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-common.TemplateSerialized._meta", "type": "Object", "label": "_meta", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 25 }, "signature": [ "{ [key: string]: any; } | undefined" ] }, { "tags": [], "id": "def-common.TemplateSerialized.data_stream", "type": "Object", "label": "data_stream", "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 26 }, "signature": [ "{} | undefined" ] } ], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 15 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "tags": [], "id": "def-common.API_BASE_PATH", "type": "string", "label": "API_BASE_PATH", "description": [], "source": { "path": "x-pack/plugins/index_management/common/constants/api_base_path.ts", "lineNumber": 8 }, "signature": [ "\"/api/index_management\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-common.BASE_PATH", "type": "string", "label": "BASE_PATH", "description": [], "source": { "path": "x-pack/plugins/index_management/common/constants/base_path.ts", "lineNumber": 8 }, "signature": [ "\"/management/data/index_management/\"" ], "initialIsOpen": false }, { "id": "def-common.Health", "type": "Type", "label": "Health", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/data_streams.ts", "lineNumber": 51 }, "signature": [ "\"green\" | \"yellow\" | \"red\"" ], "initialIsOpen": false }, { "id": "def-common.TemplateType", "type": "Type", "label": "TemplateType", "tags": [], "description": [], "source": { "path": "x-pack/plugins/index_management/common/types/templates.ts", "lineNumber": 62 }, "signature": [ "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" ], "initialIsOpen": false } ], "objects": [] } }