{ "id": "usageCollection", "client": { "classes": [], "functions": [ { "parentPluginId": "usageCollection", "id": "def-public.TrackApplicationView", "type": "Function", "tags": [ "constructor" ], "label": "TrackApplicationView", "description": [ "\nReact component to track the number of clicks and minutes on screen of the children components." ], "signature": [ "(props: ", { "pluginId": "usageCollection", "scope": "public", "docId": "kibUsageCollectionPluginApi", "section": "def-public.TrackApplicationViewProps", "text": "TrackApplicationViewProps" }, ") => React.JSX.Element" ], "path": "src/platform/plugins/shared/usage_collection/public/components/track_application_view/track_application_view.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.TrackApplicationView.$1", "type": "Object", "tags": [], "label": "props", "description": [ "{@link TrackApplicationViewProps }" ], "signature": [ { "pluginId": "usageCollection", "scope": "public", "docId": "kibUsageCollectionPluginApi", "section": "def-public.TrackApplicationViewProps", "text": "TrackApplicationViewProps" } ], "path": "src/platform/plugins/shared/usage_collection/public/components/track_application_view/track_application_view.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "usageCollection", "id": "def-public.TrackApplicationViewProps", "type": "Interface", "tags": [], "label": "TrackApplicationViewProps", "description": [ "\nProps to provide to the {@link TrackApplicationView} component." ], "path": "src/platform/plugins/shared/usage_collection/public/components/track_application_view/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.TrackApplicationViewProps.viewId", "type": "string", "tags": [], "label": "viewId", "description": [ "\nThe name of the view to be tracked. The appId will be obtained automatically." ], "path": "src/platform/plugins/shared/usage_collection/public/components/track_application_view/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-public.TrackApplicationViewProps.children", "type": "CompoundType", "tags": [], "label": "children", "description": [ "\nThe React component to be tracked." ], "signature": [ "string | number | boolean | React.ReactElement> | Iterable | React.ReactPortal | null | undefined" ], "path": "src/platform/plugins/shared/usage_collection/public/components/track_application_view/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup", "type": "Interface", "tags": [], "label": "UsageCollectionSetup", "description": [ "Public's setup APIs exposed by the UsageCollection Service" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.components", "type": "Object", "tags": [], "label": "components", "description": [ "Component helpers to track usage collection in the UI" ], "signature": [ "{ ApplicationUsageTrackingProvider: React.FC<{ children?: React.ReactNode; }>; }" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.reportUiCounter", "type": "Function", "tags": [], "label": "reportUiCounter", "description": [ "Report whenever a UI event occurs for UI counters to report it" ], "signature": [ "(appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.reportUiCounter.$1", "type": "string", "tags": [], "label": "appName", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.reportUiCounter.$2", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.reportUiCounter.$3", "type": "CompoundType", "tags": [], "label": "eventNames", "description": [], "signature": [ "string | string[]" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionSetup.reportUiCounter.$4", "type": "number", "tags": [], "label": "count", "description": [], "signature": [ "number | undefined" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart", "type": "Interface", "tags": [], "label": "UsageCollectionStart", "description": [ "Public's start APIs exposed by the UsageCollection Service" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart.reportUiCounter", "type": "Function", "tags": [], "label": "reportUiCounter", "description": [ "Report whenever a UI event occurs for UI counters to report it" ], "signature": [ "(appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart.reportUiCounter.$1", "type": "string", "tags": [], "label": "appName", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart.reportUiCounter.$2", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart.reportUiCounter.$3", "type": "CompoundType", "tags": [], "label": "eventNames", "description": [], "signature": [ "string | string[]" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "usageCollection", "id": "def-public.UsageCollectionStart.reportUiCounter.$4", "type": "number", "tags": [], "label": "count", "description": [], "signature": [ "number | undefined" ], "path": "src/platform/plugins/shared/usage_collection/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "usageCollection", "id": "def-server.CollectorFetchContext", "type": "Interface", "tags": [], "label": "CollectorFetchContext", "description": [ "\nThe context for the `fetch` method: It includes the most commonly used clients in the collectors (ES and SO clients).\nBoth are scoped based on the request and the context:\n- When users are requesting a sample of data, it is scoped to their role to avoid exposing data they shouldn't read\n- When building the telemetry data payload to report to the remote cluster, the requests are scoped to the `kibana` internal user\n" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.CollectorFetchContext.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [ "\nRequest-scoped Elasticsearch client" ], "signature": [ "{ create: { (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "CreateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; update: { (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateResponse", ">; (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateResponse", ", unknown>>; (this: That, params: ", "UpdateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", ">; }; get: { (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetResponse", ">; (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetResponse", ", unknown>>; (this: That, params: ", "GetRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetResponse", ">; }; delete: { (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; helpers: ", "default", "; search: { >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchResponse", ">; >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchResponse", ", unknown>>; >(this: That, params?: ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchResponse", ">; }; name: string | symbol; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kConnector]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kEsql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kInference]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kProfiling]: symbol | null; [kQueryRules]: symbol | null; [kRollup]: symbol | null; [kSearchApplication]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSimulate]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kSynonyms]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", ") => ", "default", "; asyncSearch: ", "default", "; autoscaling: ", "default", "; bulk: { (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "BulkResponse", ">; (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "BulkResponse", ", unknown>>; (this: That, params: ", "BulkRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "BulkResponse", ">; }; capabilities: { (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TODO", ">; (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TODO", ", unknown>>; (this: That, params?: ", "TODO", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "TODO", ">; }; cat: ", "default", "; ccr: ", "default", "; clearScroll: { (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClearScrollResponse", ">; (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClearScrollResponse", ", unknown>>; (this: That, params?: ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClearScrollResponse", ">; }; closePointInTime: { (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClosePointInTimeResponse", ">; (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClosePointInTimeResponse", ", unknown>>; (this: That, params: ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", ">; }; cluster: ", "default", "; connector: ", "default", "; count: { (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "CountResponse", ">; (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "CountResponse", ", unknown>>; (this: That, params?: ", "CountRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "CountResponse", ">; }; danglingIndices: ", "default", "; deleteByQuery: { (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "DeleteByQueryResponse", ">; (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "DeleteByQueryResponse", ", unknown>>; (this: That, params: ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "DeleteByQueryResponse", ">; }; deleteByQueryRethrottle: { (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TasksTaskListResponseBase", ">; (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TasksTaskListResponseBase", ", unknown>>; (this: That, params: ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TasksTaskListResponseBase", ">; }; deleteScript: { (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; enrich: ", "default", "; eql: ", "default", "; esql: ", "default", "; exists: { (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; existsSource: { (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; explain: { (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ExplainResponse", ">; (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ExplainResponse", ", unknown>>; (this: That, params: ", "ExplainRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ExplainResponse", ">; }; features: ", "default", "; fieldCaps: { (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "FieldCapsResponse", ">; (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "FieldCapsResponse", ", unknown>>; (this: That, params?: ", "FieldCapsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "FieldCapsResponse", ">; }; fleet: ", "default", "; getScript: { (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptResponse", ">; (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptResponse", ", unknown>>; (this: That, params: ", "GetScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptResponse", ">; }; getScriptContext: { (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptContextResponse", ">; (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptContextResponse", ", unknown>>; (this: That, params?: ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptContextResponse", ">; }; getScriptLanguages: { (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptLanguagesResponse", ", unknown>>; (this: That, params?: ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; }; getSource: { (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "GetSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; graph: ", "default", "; healthReport: { (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "HealthReportResponse", ">; (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "HealthReportResponse", ", unknown>>; (this: That, params?: ", "HealthReportRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "HealthReportResponse", ">; }; ilm: ", "default", "; index: { (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "IndexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; indices: ", "default", "; inference: ", "default", "; info: { (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "InfoResponse", ">; (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "InfoResponse", ", unknown>>; (this: That, params?: ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "InfoResponse", ">; }; ingest: ", "default", "; knnSearch: { (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "KnnSearchResponse", ">; (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "KnnSearchResponse", ", unknown>>; (this: That, params: ", "KnnSearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "KnnSearchResponse", ">; }; license: ", "default", "; logstash: ", "default", "; mget: { (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MgetResponse", ">; (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MgetResponse", ", unknown>>; (this: That, params?: ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MgetResponse", ">; }; migration: ", "default", "; ml: ", "default", "; monitoring: ", "default", "; msearch: { >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchResponse", ">; >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchResponse", ", unknown>>; >(this: That, params: ", "MsearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchResponse", ">; }; msearchTemplate: { >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchTemplateResponse", ">; >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchTemplateResponse", ", unknown>>; >(this: That, params: ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchTemplateResponse", ">; }; mtermvectors: { (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MtermvectorsResponse", ">; (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MtermvectorsResponse", ", unknown>>; (this: That, params?: ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", ">; }; nodes: ", "default", "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "OpenPointInTimeResponse", ">; (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "OpenPointInTimeResponse", ", unknown>>; (this: That, params: ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", ">; }; ping: { (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params?: ", "PingRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise; }; profiling: ", "default", "; putScript: { (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "PutScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; queryRules: ", "default", "; rankEval: { (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RankEvalResponse", ">; (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RankEvalResponse", ", unknown>>; (this: That, params: ", "RankEvalRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "RankEvalResponse", ">; }; reindex: { (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexResponse", ">; (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexResponse", ", unknown>>; (this: That, params: ", "ReindexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexResponse", ">; }; reindexRethrottle: { (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexRethrottleResponse", ">; (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexRethrottleResponse", ", unknown>>; (this: That, params: ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexRethrottleResponse", ">; }; renderSearchTemplate: { (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RenderSearchTemplateResponse", ", unknown>>; (this: That, params?: ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; }; rollup: ", "default", "; scriptsPainlessExecute: { (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScriptsPainlessExecuteResponse", ", unknown>>; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; }; scroll: { >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScrollResponse", ">; >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScrollResponse", ", unknown>>; >(this: That, params: ", "ScrollRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScrollResponse", ">; }; searchApplication: ", "default", "; searchMvt: { (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "SearchMvtRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; searchShards: { (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchShardsResponse", ">; (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchShardsResponse", ", unknown>>; (this: That, params?: ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchShardsResponse", ">; }; searchTemplate: { (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchTemplateResponse", ">; (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchTemplateResponse", ", unknown>>; (this: That, params?: ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", "; security: ", "default", "; shutdown: ", "default", "; simulate: ", "default", "; slm: ", "default", "; snapshot: ", "default", "; sql: ", "default", "; ssl: ", "default", "; synonyms: ", "default", "; tasks: ", "default", "; termsEnum: { (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermsEnumResponse", ">; (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermsEnumResponse", ", unknown>>; (this: That, params: ", "TermsEnumRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermsEnumResponse", ">; }; termvectors: { (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermvectorsResponse", ">; (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermvectorsResponse", ", unknown>>; (this: That, params: ", "TermvectorsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermvectorsResponse", ">; }; textStructure: ", "default", "; transform: ", "default", "; updateByQuery: { (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryResponse", ">; (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryResponse", ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryRethrottleResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; }; watcher: ", "default", "; xpack: ", "default", "; }" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-server.CollectorFetchContext.soClient", "type": "Object", "tags": [], "label": "soClient", "description": [ "\nRequest-scoped Saved Objects client" ], "signature": [ "SavedObjectsClientContract" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.ICollector", "type": "Interface", "tags": [], "label": "ICollector", "description": [ "\nCommon interface for Usage and Stats Collectors" ], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, "" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollector.log", "type": "Object", "tags": [], "label": "log", "description": [ "Logger" ], "signature": [ { "pluginId": "@kbn/logging", "scope": "common", "docId": "kibKbnLoggingPluginApi", "section": "def-common.Logger", "text": "Logger" } ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-server.ICollector.type", "type": "string", "tags": [], "label": "type", "description": [ "The registered type (aka name) of the collector" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-server.ICollector.fetch", "type": "Function", "tags": [], "label": "fetch", "description": [ "\nThe actual logic that reports the Usage collection.\nIt will be called on every collection request.\nWhatever is returned in this method will be passed through as-is under\nthe {@link ICollector.type} key.\n" ], "signature": [ "(this: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, " & ExtraOptions, context: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchContext", "text": "CollectorFetchContext" }, ") => TFetchReturn | Promise" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollector.fetch.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchContext", "text": "CollectorFetchContext" } ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "usageCollection", "id": "def-server.ICollector.isReady", "type": "Function", "tags": [], "label": "isReady", "description": [ "\nShould return `true` when it's safe to call the `fetch` method." ], "signature": [ "() => boolean | Promise" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet", "type": "Interface", "tags": [], "label": "ICollectorSet", "description": [ "\nInterface to register and manage Usage Collectors through a CollectorSet" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.makeUsageCollector", "type": "Function", "tags": [], "label": "makeUsageCollector", "description": [ "\nCreates a usage collector to collect plugin telemetry data.\nregisterCollector must be called to connect the created collector with the service." ], "signature": [ "(options: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.UsageCollectorOptions", "text": "UsageCollectorOptions" }, ") => ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, "" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.makeUsageCollector.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.UsageCollectorOptions", "text": "UsageCollectorOptions" }, "" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.registerCollector", "type": "Function", "tags": [], "label": "registerCollector", "description": [ "\nRegister a usage collector or a stats collector.\nUsed to connect the created collector to telemetry." ], "signature": [ "(collector: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, ") => void" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.registerCollector.$1", "type": "Object", "tags": [], "label": "collector", "description": [], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, "" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.getCollectorByType", "type": "Function", "tags": [], "label": "getCollectorByType", "description": [ "\nReturns a usage collector by type" ], "signature": [ "(type: string) => ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, " | undefined" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.ICollectorSet.getCollectorByType.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter", "type": "Interface", "tags": [], "label": "IUsageCounter", "description": [ "\nUsage Counter allows to keep track of any events that occur.\nBy calling {@link IUsageCounter.incrementCounter} devs can notify this\nAPI whenever the event happens." ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter.domainId", "type": "string", "tags": [], "label": "domainId", "description": [ "\nDefines a domainId (aka a namespace) under which multiple counters can be stored" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter.retentionPeriodDays", "type": "number", "tags": [], "label": "retentionPeriodDays", "description": [ "\nDefines custom retention period for the counters under this domain.\nThis is the number of days worth of counters that must be kept in the system indices.\nSee USAGE_COUNTERS_KEEP_DOCS_FOR_DAYS for default value" ], "signature": [ "number | undefined" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter.incrementCounter", "type": "Function", "tags": [], "label": "incrementCounter", "description": [ "\nNotifies the counter about a new event happening so it can increase the count internally." ], "signature": [ "(params: ", "IncrementCounterParams", ") => void" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter.incrementCounter.$1", "type": "Object", "tags": [], "label": "params", "description": [ "{@link IncrementCounterParams }" ], "signature": [ "IncrementCounterParams" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.UsageCountersSavedObjectAttributes", "type": "Interface", "tags": [], "label": "UsageCountersSavedObjectAttributes", "description": [ "\nThe attributes stored in the UsageCounters' SavedObjects" ], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.UsageCountersSavedObjectAttributes", "text": "UsageCountersSavedObjectAttributes" }, " extends ", "AbstractCounter" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/saved_objects.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "usageCollection", "id": "def-server.UsageCountersSavedObjectAttributes.count", "type": "number", "tags": [], "label": "count", "description": [ "Number of times the event has occurred" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/saved_objects.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "usageCollection", "id": "def-server.AllowedSchemaTypes", "type": "Type", "tags": [], "label": "AllowedSchemaTypes", "description": [ "\nPossible type values in the schema" ], "signature": [ "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], "path": "node_modules/@elastic/ebt/client/src/schema/types.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.CollectorFetchMethod", "type": "Type", "tags": [], "label": "CollectorFetchMethod", "description": [ "\nThe fetch method has the context of the Collector itself\n(this has access to all the properties of the collector like the logger)\nand the first parameter is {@link CollectorFetchContext}." ], "signature": [ "(this: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollector", "text": "ICollector" }, " & ExtraOptions, context: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchContext", "text": "CollectorFetchContext" }, ") => TReturn | Promise" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "usageCollection", "id": "def-server.CollectorFetchMethod.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchContext", "text": "CollectorFetchContext" } ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.CollectorOptions", "type": "Type", "tags": [], "label": "CollectorOptions", "description": [ "\nOptions to instantiate a collector" ], "signature": [ "{ type: string; isReady: () => boolean | Promise; schema?: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.MakeSchemaFrom", "text": "MakeSchemaFrom" }, " | undefined; fetch: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchMethod", "text": "CollectorFetchMethod" }, "; } & ExtraOptions" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.IncrementCounterParams", "type": "Type", "tags": [], "label": "IncrementCounterParams", "description": [], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.MakeSchemaFrom", "type": "Type", "tags": [], "label": "MakeSchemaFrom", "description": [ "\nThe `schema` property in {@link CollectorOptions} must match the output of\nthe `fetch` method. This type helps ensure that is correct" ], "signature": [ "{ [Key in keyof Required]: Required[Key] extends (infer U)[] ? { type: \"array\"; items: ", "RecursiveMakeSchemaFrom", "; } : ", "RecursiveMakeSchemaFrom", "[Key], RequireMeta>; }" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.USAGE_COUNTERS_SAVED_OBJECT_TYPE", "type": "string", "tags": [], "label": "USAGE_COUNTERS_SAVED_OBJECT_TYPE", "description": [ "The Saved Objects type for Usage Counters" ], "signature": [ "\"usage-counter\"" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/saved_objects.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.UsageCollectorOptions", "type": "Type", "tags": [], "label": "UsageCollectorOptions", "description": [ "\nSame as {@link CollectorOptions} but with the `schema` property enforced" ], "signature": [ "{ type: string; isReady: () => boolean | Promise; schema?: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.MakeSchemaFrom", "text": "MakeSchemaFrom" }, " | undefined; fetch: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchMethod", "text": "CollectorFetchMethod" }, "; } & ExtraOptions & Required boolean | Promise; schema?: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.MakeSchemaFrom", "text": "MakeSchemaFrom" }, " | undefined; fetch: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.CollectorFetchMethod", "text": "CollectorFetchMethod" }, "; }, \"schema\">>" ], "path": "src/platform/plugins/shared/usage_collection/server/collector/usage_collector.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "usageCollection", "id": "def-server.UsageCountersSavedObject", "type": "Type", "tags": [], "label": "UsageCountersSavedObject", "description": [ "\nThe structure of the SavedObjects of type \"usage-counters\"" ], "signature": [ "SavedObject", "<", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.UsageCountersSavedObjectAttributes", "text": "UsageCountersSavedObjectAttributes" }, ">" ], "path": "src/platform/plugins/shared/usage_collection/server/usage_counters/saved_objects.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "usageCollection", "id": "def-server.UsageCollectionSetup", "type": "Type", "tags": [], "label": "UsageCollectionSetup", "description": [ "Plugin's setup API" ], "signature": [ { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", "section": "def-server.ICollectorSet", "text": "ICollectorSet" }, " & ", "UsageCountersServiceSetup" ], "path": "src/platform/plugins/shared/usage_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "usageCollection", "id": "def-server.UsageCollectionStart", "type": "Type", "tags": [], "label": "UsageCollectionStart", "description": [ "Plugin's start API" ], "signature": [ "UsageCountersServiceStart" ], "path": "src/platform/plugins/shared/usage_collection/server/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }