kibana/api_docs/dataset_quality.devdocs.json

1427 lines
No EOL
59 KiB
JSON

{
"id": "datasetQuality",
"client": {
"classes": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DataStreamsStatsService",
"type": "Class",
"tags": [],
"label": "DataStreamsStatsService",
"description": [],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/data_streams_stats_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DataStreamsStatsService.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/data_streams_stats_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.DataStreamsStatsService.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"({ http }: ",
"DataStreamsStatsServiceStartDeps",
") => ",
"DataStreamsStatsServiceStart"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/data_streams_stats_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DataStreamsStatsService.start.$1",
"type": "Object",
"tags": [],
"label": "{ http }",
"description": [],
"signature": [
"DataStreamsStatsServiceStartDeps"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/data_streams_stats_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient",
"type": "Interface",
"tags": [],
"label": "IDataStreamsStatsClient",
"description": [],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsStats",
"type": "Function",
"tags": [],
"label": "getDataStreamsStats",
"description": [],
"signature": [
"(params?: (({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined) => Promise<{ datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsStats.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"(({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsDegradedStats",
"type": "Function",
"tags": [],
"label": "getDataStreamsDegradedStats",
"description": [],
"signature": [
"(params?: ({ start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { datasetQuery?: string | undefined; }) | undefined) => Promise<{ dataset: string; count: number; }[]>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsDegradedStats.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"({ start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { datasetQuery?: string | undefined; }) | undefined"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsFailedStats",
"type": "Function",
"tags": [],
"label": "getDataStreamsFailedStats",
"description": [],
"signature": [
"(params?: ({ start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { datasetQuery?: string | undefined; }) | undefined) => Promise<{ dataset: string; count: number; }[]>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsFailedStats.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"({ start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { datasetQuery?: string | undefined; }) | undefined"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsTotalDocs",
"type": "Function",
"tags": [],
"label": "getDataStreamsTotalDocs",
"description": [],
"signature": [
"(params: { start: string; end: string; } & { type: \"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\"; }) => Promise<{ dataset: string; count: number; }[]>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getDataStreamsTotalDocs.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ start: string; end: string; } & { type: \"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\"; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getIntegrations",
"type": "Function",
"tags": [],
"label": "getIntegrations",
"description": [],
"signature": [
"() => Promise<",
"Integration",
"[]>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getNonAggregatableDatasets",
"type": "Function",
"tags": [],
"label": "getNonAggregatableDatasets",
"description": [],
"signature": [
"(params: { start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { dataStream?: string | undefined; }) => Promise<{ aggregatable: boolean; datasets: string[]; }>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.IDataStreamsStatsClient.getNonAggregatableDatasets.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ start: string; end: string; } & { types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } & { dataStream?: string | undefined; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DataStreamStatServiceResponse",
"type": "Type",
"tags": [],
"label": "DataStreamStatServiceResponse",
"description": [],
"signature": [
"{ datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/data_streams_stats/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginSetup",
"type": "Interface",
"tags": [],
"label": "DatasetQualityPluginSetup",
"description": [],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart",
"type": "Interface",
"tags": [],
"label": "DatasetQualityPluginStart",
"description": [],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.DatasetQuality",
"type": "CompoundType",
"tags": [],
"label": "DatasetQuality",
"description": [],
"signature": [
"React.ComponentClass<",
"DatasetQualityProps",
", any> | React.FunctionComponent<",
"DatasetQualityProps",
">"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityController",
"type": "Function",
"tags": [],
"label": "createDatasetQualityController",
"description": [],
"signature": [
"({ initialState, }: { initialState?: Partial<",
"DatasetQualityPublicState",
"> | undefined; }) => Promise<",
"DatasetQualityController",
">"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityController.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ initialState?: Partial<",
"DatasetQualityPublicState",
"> | undefined; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/controller/dataset_quality/create_controller.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.DatasetQualityDetails",
"type": "CompoundType",
"tags": [],
"label": "DatasetQualityDetails",
"description": [],
"signature": [
"React.ComponentClass<",
"DatasetQualityDetailsProps",
", any> | React.FunctionComponent<",
"DatasetQualityDetailsProps",
">"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityDetailsController",
"type": "Function",
"tags": [],
"label": "createDatasetQualityDetailsController",
"description": [],
"signature": [
"({ initialState, }: { initialState: ",
"DatasetQualityDetailsPublicStateUpdate",
"; }) => Promise<",
"DatasetQualityDetailsController",
">"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityDetailsController.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ initialState: ",
"DatasetQualityDetailsPublicStateUpdate",
"; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/controller/dataset_quality_details/create_controller.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "datasetQuality",
"id": "def-common.indexNameToDataStreamParts",
"type": "Function",
"tags": [],
"label": "indexNameToDataStreamParts",
"description": [],
"signature": [
"(dataStreamName: string) => { type: \"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\"; dataset: string; namespace: string; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/utils/dataset_name.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "datasetQuality",
"id": "def-common.indexNameToDataStreamParts.$1",
"type": "string",
"tags": [],
"label": "dataStreamName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/utils/dataset_name.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "datasetQuality",
"id": "def-common.DatasetQualityConfig",
"type": "Interface",
"tags": [],
"label": "DatasetQualityConfig",
"description": [],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/plugin_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "datasetQuality",
"id": "def-common.APIClientRequestParamsOf",
"type": "Type",
"tags": [],
"label": "APIClientRequestParamsOf",
"description": [],
"signature": [
"{ \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/integrations/{integration}/dashboards\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ integration: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { dashboards: { id: string; title: string; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/integrations\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/integrations\", undefined, ",
"DatasetQualityRouteHandlerResources",
", { integrations: ({ name: string; } & { title?: string | undefined; version?: string | undefined; icons?: ({ src: string; } & { path?: string | undefined; size?: string | undefined; title?: string | undefined; type?: string | undefined; })[] | undefined; datasets?: { [x: string]: string; } | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs/errors\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs/errors\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { errors: { message: string; type: string; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { count: number; lastOccurrence: number | null | undefined; timeSeries: { x: number; y: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/failed_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/failed_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ datasetQuery: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { failedDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"POST /internal/dataset_quality/data_streams/{dataStream}/rollover\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"POST /internal/dataset_quality/data_streams/{dataStream}/rollover\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { acknowledged: boolean; }, ",
"DatasetQualityRouteCreateOptions",
">; \"PUT /internal/dataset_quality/data_streams/{dataStream}/update_field_limit\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"PUT /internal/dataset_quality/data_streams/{dataStream}/update_field_limit\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ newFieldLimit: ",
"NumberC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isComponentTemplateUpdated: boolean | undefined; isLatestBackingIndexUpdated: boolean | undefined; customComponentTemplateName: string; } & { error?: string | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/analyze\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/analyze\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; degradedField: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ lastBackingIndex: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isFieldLimitIssue: boolean; fieldCount: number; totalFieldLimit: number; } & { ignoreMalformed?: boolean | undefined; nestedFieldLimit?: number | undefined; fieldMapping?: { type?: string | undefined; ignore_above?: number | undefined; } | undefined; defaultPipeline?: string | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/integration/check\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/integration/check\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isIntegration: false; areAssetsAvailable: boolean; } | { isIntegration: true; areAssetsAvailable: true; integration: { name: string; } & { title?: string | undefined; version?: string | undefined; icons?: ({ src: string; } & { path?: string | undefined; size?: string | undefined; title?: string | undefined; type?: string | undefined; })[] | undefined; datasets?: { [x: string]: string; } | undefined; }; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/settings\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/settings\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/details\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; } | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; degradedField: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { field: string; values: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_fields\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_fields\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { degradedFields: ({ count: number; lastOccurrence: number | null | undefined; timeSeries: { x: number; y: number; }[]; } & { name: string; indexFieldWasLastPresentIn: string; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/non_aggregatable\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/non_aggregatable\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ type: ",
"KeyofC",
"<{ logs: null; metrics: null; traces: null; synthetics: null; profiling: null; }>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { aggregatable: boolean; datasets: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/non_aggregatable\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/non_aggregatable\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ dataStream: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { aggregatable: boolean; datasets: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/total_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/total_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ type: ",
"KeyofC",
"<{ logs: null; metrics: null; traces: null; synthetics: null; profiling: null; }>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { totalDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/degraded_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/degraded_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ datasetQuery: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { degradedDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/stats\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/stats\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"UnionC",
"<[",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"TypeC",
"<{ datasetQuery: ",
"StringC",
"; }>]>, ",
"PartialC",
"<{ includeCreationDate: ",
"Type",
"<boolean, boolean, unknown>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; }[TEndpoint] extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<any, infer TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRouteCreateOptions",
"text": "ServerRouteCreateOptions"
},
" | undefined> ? TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" ? ClientRequestParamsOfType<TRouteParamsRT> : TRouteParamsRT extends undefined ? {} : never : never"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/rest/create_call_dataset_quality_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "datasetQuality",
"id": "def-common.APIReturnType",
"type": "Type",
"tags": [],
"label": "APIReturnType",
"description": [],
"signature": [
"{ \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/integrations/{integration}/dashboards\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ integration: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { dashboards: { id: string; title: string; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/integrations\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/integrations\", undefined, ",
"DatasetQualityRouteHandlerResources",
", { integrations: ({ name: string; } & { title?: string | undefined; version?: string | undefined; icons?: ({ src: string; } & { path?: string | undefined; size?: string | undefined; title?: string | undefined; type?: string | undefined; })[] | undefined; datasets?: { [x: string]: string; } | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs/errors\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs/errors\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { errors: { message: string; type: string; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/failed_docs\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { count: number; lastOccurrence: number | null | undefined; timeSeries: { x: number; y: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/failed_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/failed_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ datasetQuery: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { failedDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"POST /internal/dataset_quality/data_streams/{dataStream}/rollover\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"POST /internal/dataset_quality/data_streams/{dataStream}/rollover\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { acknowledged: boolean; }, ",
"DatasetQualityRouteCreateOptions",
">; \"PUT /internal/dataset_quality/data_streams/{dataStream}/update_field_limit\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"PUT /internal/dataset_quality/data_streams/{dataStream}/update_field_limit\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ newFieldLimit: ",
"NumberC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isComponentTemplateUpdated: boolean | undefined; isLatestBackingIndexUpdated: boolean | undefined; customComponentTemplateName: string; } & { error?: string | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/analyze\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/analyze\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; degradedField: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ lastBackingIndex: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isFieldLimitIssue: boolean; fieldCount: number; totalFieldLimit: number; } & { ignoreMalformed?: boolean | undefined; nestedFieldLimit?: number | undefined; fieldMapping?: { type?: string | undefined; ignore_above?: number | undefined; } | undefined; defaultPipeline?: string | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/integration/check\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/integration/check\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { isIntegration: false; areAssetsAvailable: boolean; } | { isIntegration: true; areAssetsAvailable: true; integration: { name: string; } & { title?: string | undefined; version?: string | undefined; icons?: ({ src: string; } & { path?: string | undefined; size?: string | undefined; title?: string | undefined; type?: string | undefined; })[] | undefined; datasets?: { [x: string]: string; } | undefined; }; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/settings\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/settings\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/details\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; } | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; degradedField: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { field: string; values: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_fields\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_fields\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { degradedFields: ({ count: number; lastOccurrence: number | null | undefined; timeSeries: { x: number; y: number; }[]; } & { name: string; indexFieldWasLastPresentIn: string; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/non_aggregatable\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/{dataStream}/non_aggregatable\", ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ dataStream: ",
"StringC",
"; }>; query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ type: ",
"KeyofC",
"<{ logs: null; metrics: null; traces: null; synthetics: null; profiling: null; }>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { aggregatable: boolean; datasets: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/non_aggregatable\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/non_aggregatable\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ dataStream: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { aggregatable: boolean; datasets: string[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/total_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/total_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ type: ",
"KeyofC",
"<{ logs: null; metrics: null; traces: null; synthetics: null; profiling: null; }>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { totalDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/degraded_docs\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/degraded_docs\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"TypeC",
"<{ start: ",
"Type",
"<number, string, unknown>; end: ",
"Type",
"<number, string, unknown>; }>, ",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"PartialC",
"<{ datasetQuery: ",
"StringC",
"; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { degradedDocs: { dataset: string; count: number; }[]; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/stats\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/data_streams/stats\", ",
"TypeC",
"<{ query: ",
"IntersectionC",
"<[",
"UnionC",
"<[",
"TypeC",
"<{ types: ",
"Type",
"<(\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[], unknown>; }>, ",
"TypeC",
"<{ datasetQuery: ",
"StringC",
"; }>]>, ",
"PartialC",
"<{ includeCreationDate: ",
"Type",
"<boolean, boolean, unknown>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; }[TEndpoint] extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<any, any, any, infer TReturnType extends ServerRouteHandlerReturnType, any> ? TReturnType extends ",
"IKibanaResponse",
"<infer TWrappedResponseType extends string | Record<string, any> | Error | Buffer | ",
"Stream",
" | { message: string | Error; attributes?: ",
"ResponseErrorAttributes",
" | undefined; } | undefined> ? TWrappedResponseType : TReturnType : never"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/rest/create_call_dataset_quality_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "datasetQuality",
"id": "def-common.FetchOptions",
"type": "Type",
"tags": [],
"label": "FetchOptions",
"description": [],
"signature": [
"Omit<",
"HttpFetchOptions",
", \"body\"> & { pathname: string; method?: string | undefined; body?: any; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/fetch_options.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}