943 lines
36 KiB
JSON
943 lines
36 KiB
JSON
{
|
|
"id": "telemetryCollectionManager",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.ClusterDetails",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ClusterDetails",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.ClusterDetails.clusterUuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "clusterUuid",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "StatsCollectionConfig",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionConfig.usageCollection",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectionSetup",
|
|
"text": "UsageCollectionSetup"
|
|
}
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionConfig.esClient",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"KibanaClient",
|
|
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
|
|
"TransportRequestParams",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TResponse, unknown>>; }; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionConfig.soClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionConfig.kibanaRequest",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibanaRequest",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any> | undefined"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "StatsCollectionContext",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionContext.logger",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "server",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-server.Logger",
|
|
"text": "Logger"
|
|
},
|
|
" | Console"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsCollectionContext.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.UsageStatsPayload",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UsageStatsPayload",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.UsageStatsPayload",
|
|
"text": "UsageStatsPayload"
|
|
},
|
|
" extends ",
|
|
"BasicStatsPayload"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.UsageStatsPayload.collectionSource",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "collectionSource",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.ClusterDetailsGetter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ClusterDetailsGetter",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionConfig",
|
|
"text": "StatsCollectionConfig"
|
|
},
|
|
", context: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionContext",
|
|
"text": "StatsCollectionContext"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.ClusterDetails",
|
|
"text": "ClusterDetails"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.ClusterDetailsGetter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionConfig",
|
|
"text": "StatsCollectionConfig"
|
|
}
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.ClusterDetailsGetter.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionContext",
|
|
"text": "StatsCollectionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsGetter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "StatsGetter",
|
|
"description": [],
|
|
"signature": [
|
|
"(clustersDetails: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.ClusterDetails",
|
|
"text": "ClusterDetails"
|
|
},
|
|
"[], config: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionConfig",
|
|
"text": "StatsCollectionConfig"
|
|
},
|
|
", context: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionContext",
|
|
"text": "StatsCollectionContext"
|
|
},
|
|
") => Promise<T[]>"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsGetter.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "clustersDetails",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.ClusterDetails",
|
|
"text": "ClusterDetails"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsGetter.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionConfig",
|
|
"text": "StatsCollectionConfig"
|
|
}
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsGetter.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.StatsCollectionContext",
|
|
"text": "StatsCollectionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.StatsGetterConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "StatsGetterConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"UnencryptedStatsGetterConfig",
|
|
" | ",
|
|
"EncryptedStatsGetterConfig"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TelemetryCollectionManagerPluginSetup",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setCollectionStrategy",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends ",
|
|
"BasicStatsPayload",
|
|
">(collectionConfig: ",
|
|
"CollectionStrategyConfig",
|
|
"<T>) => void"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "collectionConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"CollectionStrategyConfig",
|
|
"<T>"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.getOptInStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOptInStats",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (optInStatus: boolean, config: ",
|
|
"UnencryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: ",
|
|
"OptInStatsPayload",
|
|
"; }[]>; (optInStatus: boolean, config: ",
|
|
"EncryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: string; }[]>; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.getStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStats",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (config: ",
|
|
"UnencryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.UsageStatsPayload",
|
|
"text": "UsageStatsPayload"
|
|
},
|
|
"; }[]>; (config: ",
|
|
"EncryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: string; }[]>; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginSetup.areAllCollectorsReady",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "areAllCollectorsReady",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean | undefined>"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TelemetryCollectionManagerPluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.getOptInStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOptInStats",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (optInStatus: boolean, config: ",
|
|
"UnencryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: ",
|
|
"OptInStatsPayload",
|
|
"; }[]>; (optInStatus: boolean, config: ",
|
|
"EncryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: string; }[]>; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.getStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStats",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (config: ",
|
|
"UnencryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: ",
|
|
{
|
|
"pluginId": "telemetryCollectionManager",
|
|
"scope": "server",
|
|
"docId": "kibTelemetryCollectionManagerPluginApi",
|
|
"section": "def-server.UsageStatsPayload",
|
|
"text": "UsageStatsPayload"
|
|
},
|
|
"; }[]>; (config: ",
|
|
"EncryptedStatsGetterConfig",
|
|
"): Promise<{ clusterUuid: string; stats: string; }[]>; }"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-server.TelemetryCollectionManagerPluginStart.areAllCollectorsReady",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "areAllCollectorsReady",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean | undefined>"
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-common.PLUGIN_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PLUGIN_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"telemetryCollectionManager\""
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "telemetryCollectionManager",
|
|
"id": "def-common.PLUGIN_NAME",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PLUGIN_NAME",
|
|
"description": [],
|
|
"signature": [
|
|
"\"telemetry_collection_manager\""
|
|
],
|
|
"path": "src/plugins/telemetry_collection_manager/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |