github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_generate_csv.devdocs.json

477 lines
No EOL
17 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/generate-csv",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator",
"type": "Class",
"tags": [],
"label": "CsvESQLGenerator",
"description": [],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "job",
"description": [],
"signature": [
{
"pluginId": "@kbn/generate-csv",
"scope": "server",
"docId": "kibKbnGenerateCsvPluginApi",
"section": "def-server.JobParamsCsvESQL",
"text": "JobParamsCsvESQL"
}
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Readonly<{ enablePanelActionDownload?: boolean | undefined; } & { scroll: Readonly<{} & { size: number; duration: string; strategy: \"scroll\" | \"pit\"; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; maxSizeBytes: number | ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ByteSizeValue",
"text": "ByteSizeValue"
},
"; useByteOrderMarkEncoding: boolean; maxConcurrentShardRequests: number; }>"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "taskInstanceFields",
"description": [],
"signature": [
"TaskInstanceFields"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$4",
"type": "Object",
"tags": [],
"label": "clients",
"description": [],
"signature": [
"Clients"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$5",
"type": "Object",
"tags": [],
"label": "cancellationToken",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.CancellationToken",
"text": "CancellationToken"
}
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$6",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.Unnamed.$7",
"type": "Object",
"tags": [],
"label": "stream",
"description": [],
"signature": [
"Writable"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvESQLGenerator.generateData",
"type": "Function",
"tags": [],
"label": "generateData",
"description": [],
"signature": [
"() => Promise<",
"TaskRunResult",
">"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator",
"type": "Class",
"tags": [],
"label": "CsvGenerator",
"description": [],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "job",
"description": [],
"signature": [
"Omit<",
"JobParamsCSV",
", \"version\">"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Readonly<{ enablePanelActionDownload?: boolean | undefined; } & { scroll: Readonly<{} & { size: number; duration: string; strategy: \"scroll\" | \"pit\"; }>; checkForFormulas: boolean; escapeFormulaValues: boolean; maxSizeBytes: number | ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ByteSizeValue",
"text": "ByteSizeValue"
},
"; useByteOrderMarkEncoding: boolean; maxConcurrentShardRequests: number; }>"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "taskInstanceFields",
"description": [],
"signature": [
"TaskInstanceFields"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$4",
"type": "Object",
"tags": [],
"label": "clients",
"description": [],
"signature": [
"Clients"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$5",
"type": "Object",
"tags": [],
"label": "dependencies",
"description": [],
"signature": [
"Dependencies"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$6",
"type": "Object",
"tags": [],
"label": "cancellationToken",
"description": [],
"signature": [
{
"pluginId": "@kbn/reporting-common",
"scope": "common",
"docId": "kibKbnReportingCommonPluginApi",
"section": "def-common.CancellationToken",
"text": "CancellationToken"
}
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$7",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.Unnamed.$8",
"type": "Object",
"tags": [],
"label": "stream",
"description": [],
"signature": [
"Writable"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.CsvGenerator.generateData",
"type": "Function",
"tags": [],
"label": "generateData",
"description": [],
"signature": [
"() => Promise<",
"TaskRunResult",
">"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.JobParamsCsvESQL",
"type": "Interface",
"tags": [],
"label": "JobParamsCsvESQL",
"description": [],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.JobParamsCsvESQL.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ esql: string; }"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.JobParamsCsvESQL.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.JobParamsCsvESQL.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/generate-csv",
"id": "def-server.JobParamsCsvESQL.browserTimezone",
"type": "string",
"tags": [],
"label": "browserTimezone",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-generate-csv/src/generate_csv_esql.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink