{ "id": "telemetryCollectionManager", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [ { "id": "def-server.ClusterDetails", "type": "Interface", "label": "ClusterDetails", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.ClusterDetails.clusterUuid", "type": "string", "label": "clusterUuid", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 53 } } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 52 }, "initialIsOpen": false }, { "id": "def-server.StatsCollectionConfig", "type": "Interface", "label": "StatsCollectionConfig", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.StatsCollectionConfig.usageCollection", "type": "Object", "label": "usageCollection", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 57 }, "signature": [ "Pick<", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorSet", "text": "CollectorSet" }, ", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\">" ] }, { "tags": [], "id": "def-server.StatsCollectionConfig.esClient", "type": "CompoundType", "label": "esClient", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 58 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.ElasticsearchClient", "text": "ElasticsearchClient" } ] }, { "tags": [], "id": "def-server.StatsCollectionConfig.soClient", "type": "Object", "label": "soClient", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 59 }, "signature": [ "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClient", "text": "SavedObjectsClient" }, ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">" ] }, { "tags": [], "id": "def-server.StatsCollectionConfig.kibanaRequest", "type": "Object", "label": "kibanaRequest", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 60 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | undefined" ] } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 56 }, "initialIsOpen": false }, { "id": "def-server.StatsCollectionContext", "type": "Interface", "label": "StatsCollectionContext", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.StatsCollectionContext.logger", "type": "CompoundType", "label": "logger", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 78 }, "signature": [ "Logger", " | Console" ] }, { "tags": [], "id": "def-server.StatsCollectionContext.version", "type": "string", "label": "version", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 79 } } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 77 }, "initialIsOpen": false }, { "id": "def-server.UsageStatsPayload", "type": "Interface", "label": "UsageStatsPayload", "signature": [ "UsageStatsPayload", " extends ", "BasicStatsPayload" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.UsageStatsPayload.collectionSource", "type": "string", "label": "collectionSource", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 74 } } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 73 }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-server.ClusterDetailsGetter", "type": "Type", "label": "ClusterDetailsGetter", "tags": [], "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 83 }, "signature": [ "(config: ", "StatsCollectionConfig", ", context: ", "StatsCollectionContext", ") => Promise<", "ClusterDetails", "[]>" ], "initialIsOpen": false }, { "id": "def-server.StatsGetter", "type": "Type", "label": "StatsGetter", "tags": [], "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 87 }, "signature": [ "(clustersDetails: ", "ClusterDetails", "[], config: ", "StatsCollectionConfig", ", context: ", "StatsCollectionContext", ") => Promise" ], "initialIsOpen": false }, { "id": "def-server.StatsGetterConfig", "type": "Type", "label": "StatsGetterConfig", "tags": [], "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 82 }, "signature": [ "UnencryptedStatsGetterConfig", " | ", "EncryptedStatsGetterConfig" ], "initialIsOpen": false } ], "objects": [], "setup": { "id": "def-server.TelemetryCollectionManagerPluginSetup", "type": "Interface", "label": "TelemetryCollectionManagerPluginSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy", "type": "Function", "label": "setCollectionStrategy", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 19 }, "signature": [ "(collectionConfig: ", { "pluginId": "telemetry", "scope": "common", "docId": "kibTelemetryPluginApi", "section": "def-common.CollectionStrategyConfig", "text": "CollectionStrategyConfig" }, ") => void" ] }, { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginSetup.getOptInStats", "type": "Function", "label": "getOptInStats", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 22 }, "signature": [ "(optInStatus: boolean, config: ", { "pluginId": "telemetry", "scope": "common", "docId": "kibTelemetryPluginApi", "section": "def-common.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" ] }, { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginSetup.getStats", "type": "Function", "label": "getStats", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 23 }, "signature": [ "(config: ", { "pluginId": "telemetry", "scope": "common", "docId": "kibTelemetryPluginApi", "section": "def-common.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" ] }, { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginSetup.areAllCollectorsReady", "type": "Function", "label": "areAllCollectorsReady", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 24 }, "signature": [ "() => Promise" ] } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 18 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-server.TelemetryCollectionManagerPluginStart", "type": "Interface", "label": "TelemetryCollectionManagerPluginStart", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginStart.getOptInStats", "type": "Function", "label": "getOptInStats", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 28 }, "signature": [ "(optInStatus: boolean, config: ", { "pluginId": "telemetry", "scope": "common", "docId": "kibTelemetryPluginApi", "section": "def-common.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" ] }, { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginStart.getStats", "type": "Function", "label": "getStats", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 29 }, "signature": [ "(config: ", { "pluginId": "telemetry", "scope": "common", "docId": "kibTelemetryPluginApi", "section": "def-common.StatsGetterConfig", "text": "StatsGetterConfig" }, ") => Promise" ] }, { "tags": [], "id": "def-server.TelemetryCollectionManagerPluginStart.areAllCollectorsReady", "type": "Function", "label": "areAllCollectorsReady", "description": [], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 30 }, "signature": [ "() => Promise" ] } ], "source": { "path": "src/plugins/telemetry_collection_manager/server/types.ts", "lineNumber": 27 }, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }