kibana/api_docs/file_upload.json
Nathan Reese 7507d6417e
Convert file_upload components to typescript (#93814)
* Convert file_upload components to typescript

* i18n cleanup

* api doc updates

* fix i18n files

* tslint after merge

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-08 14:15:38 -07:00

1723 lines
49 KiB
JSON

{
"id": "fileUpload",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.CreateDocsResponse",
"type": "Interface",
"label": "CreateDocsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CreateDocsResponse.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-public.CreateDocsResponse.remainder",
"type": "number",
"label": "remainder",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-public.CreateDocsResponse.docs",
"type": "Array",
"label": "docs",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportDoc",
"text": "ImportDoc"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.CreateDocsResponse.error",
"type": "Any",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 34
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 30
},
"initialIsOpen": false
},
{
"id": "def-public.Doc",
"type": "Interface",
"label": "Doc",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Doc.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 26
}
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-public.FileUploadComponentProps",
"type": "Interface",
"label": "FileUploadComponentProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FileUploadComponentProps.isIndexingTriggered",
"type": "boolean",
"label": "isIndexingTriggered",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-public.FileUploadComponentProps.onFileUpload",
"type": "Function",
"label": "onFileUpload",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 15
},
"signature": [
"(geojsonFile: GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>, name: string, previewCoverage: number) => void"
]
},
{
"tags": [],
"id": "def-public.FileUploadComponentProps.onFileRemove",
"type": "Function",
"label": "onFileRemove",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 16
},
"signature": [
"() => void"
]
},
{
"tags": [],
"id": "def-public.FileUploadComponentProps.onIndexReady",
"type": "Function",
"label": "onIndexReady",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 17
},
"signature": [
"(indexReady: boolean) => void"
]
},
{
"tags": [],
"id": "def-public.FileUploadComponentProps.onIndexingComplete",
"type": "Function",
"label": "onIndexingComplete",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 18
},
"signature": [
"(results: { indexDataResp: ",
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.ImportResults",
"text": "ImportResults"
},
"; indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
"; }) => void"
]
},
{
"tags": [],
"id": "def-public.FileUploadComponentProps.onIndexingError",
"type": "Function",
"label": "onIndexingError",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 22
},
"signature": [
"() => void"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-public.IImporter",
"type": "Interface",
"label": "IImporter",
"description": [],
"tags": [],
"children": [
{
"id": "def-public.IImporter.read",
"type": "Function",
"label": "read",
"signature": [
"(data: ArrayBuffer) => { success: boolean; }"
],
"description": [],
"children": [
{
"type": "Object",
"label": "data",
"isRequired": true,
"signature": [
"ArrayBuffer"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 44
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 44
}
},
{
"id": "def-public.IImporter.initializeImport",
"type": "Function",
"label": "initializeImport",
"signature": [
"(index: string, settings: ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Settings",
"text": "Settings"
},
", mappings: ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
},
", pipeline: ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
},
") => Promise<",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportResponse",
"text": "ImportResponse"
},
">"
],
"description": [],
"children": [
{
"type": "string",
"label": "index",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 46
}
},
{
"type": "Object",
"label": "settings",
"isRequired": true,
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Settings",
"text": "Settings"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 47
}
},
{
"type": "Object",
"label": "mappings",
"isRequired": true,
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 48
}
},
{
"type": "Object",
"label": "pipeline",
"isRequired": true,
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 49
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 45
}
},
{
"id": "def-public.IImporter.import",
"type": "Function",
"label": "import",
"signature": [
"(id: string, index: string, pipelineId: string | undefined, setImportProgress: (progress: number) => void) => Promise<",
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.ImportResults",
"text": "ImportResults"
},
">"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 52
}
},
{
"type": "string",
"label": "index",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 53
}
},
{
"type": "string",
"label": "pipelineId",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 54
}
},
{
"type": "Function",
"label": "setImportProgress",
"isRequired": true,
"signature": [
"(progress: number) => void"
],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 55
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 51
}
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 43
},
"initialIsOpen": false
},
{
"id": "def-public.ImportConfig",
"type": "Interface",
"label": "ImportConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ImportConfig.settings",
"type": "Object",
"label": "settings",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 18
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Settings",
"text": "Settings"
}
]
},
{
"tags": [],
"id": "def-public.ImportConfig.mappings",
"type": "Object",
"label": "mappings",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Mappings",
"text": "Mappings"
}
]
},
{
"tags": [],
"id": "def-public.ImportConfig.pipeline",
"type": "Object",
"label": "pipeline",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-public.ImportFactoryOptions",
"type": "Interface",
"label": "ImportFactoryOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ImportFactoryOptions.excludeLinesPattern",
"type": "string",
"label": "excludeLinesPattern",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 38
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportFactoryOptions.multilineStartPattern",
"type": "string",
"label": "multilineStartPattern",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 39
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportFactoryOptions.importConfig",
"type": "Object",
"label": "importConfig",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 40
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.ImportConfig",
"text": "ImportConfig"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.ImportFailure",
"type": "Interface",
"label": "ImportFailure",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ImportFailure.item",
"type": "number",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-public.ImportFailure.reason",
"type": "string",
"label": "reason",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-public.ImportFailure.doc",
"type": "CompoundType",
"label": "doc",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportDoc",
"text": "ImportDoc"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-public.ImportResponse",
"type": "Interface",
"label": "ImportResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ImportResponse.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-public.ImportResponse.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-public.ImportResponse.index",
"type": "string",
"label": "index",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 11
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportResponse.pipelineId",
"type": "string",
"label": "pipelineId",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 12
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportResponse.docCount",
"type": "number",
"label": "docCount",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.ImportResponse.failures",
"type": "Array",
"label": "failures",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportFailure",
"text": "ImportFailure"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.ImportResponse.error",
"type": "Any",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 15
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-public.ImportResponse.ingestError",
"type": "CompoundType",
"label": "ingestError",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 16
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-public.ImportResults",
"type": "Interface",
"label": "ImportResults",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ImportResults.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 24
}
},
{
"tags": [],
"id": "def-public.ImportResults.failures",
"type": "Array",
"label": "failures",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 25
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportFailure",
"text": "ImportFailure"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportResults.docCount",
"type": "number",
"label": "docCount",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 26
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-public.ImportResults.error",
"type": "Any",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 27
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/public/importer/types.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-public.IngestPipeline",
"type": "Interface",
"label": "IngestPipeline",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IngestPipeline.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-public.IngestPipeline.processors",
"type": "Array",
"label": "processors",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 54
},
"signature": [
"any[]"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 52
},
"initialIsOpen": false
},
{
"id": "def-public.IngestPipelineWrapper",
"type": "Interface",
"label": "IngestPipelineWrapper",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IngestPipelineWrapper.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 48
}
},
{
"tags": [],
"id": "def-public.IngestPipelineWrapper.pipeline",
"type": "Object",
"label": "pipeline",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 49
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"id": "def-public.Mappings",
"type": "Interface",
"label": "Mappings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Mappings._meta",
"type": "Object",
"label": "_meta",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 39
},
"signature": [
"{ created_by: string; } | undefined"
]
},
{
"tags": [],
"id": "def-public.Mappings.properties",
"type": "Object",
"label": "properties",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 42
},
"signature": [
"{ [key: string]: any; }"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-public.Settings",
"type": "Interface",
"label": "Settings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Settings.pipeline",
"type": "string",
"label": "pipeline",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 32
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.Settings.index",
"type": "string",
"label": "index",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-public.Settings.body",
"type": "Array",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 34
},
"signature": [
"any[]"
]
},
{
"id": "def-public.Settings.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 35
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 31
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.ABSOLUTE_MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "ABSOLUTE_MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 14
},
"signature": [
"1073741274"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.FILE_SIZE_DISPLAY_FORMAT",
"type": "string",
"label": "FILE_SIZE_DISPLAY_FORMAT",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"0,0.[0] b\""
],
"initialIsOpen": false
},
{
"id": "def-public.ImportDoc",
"type": "Type",
"label": "ImportDoc",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 29
},
"signature": [
"string | object | ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Doc",
"text": "Doc"
}
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.INDEX_META_DATA_CREATED_BY",
"type": "string",
"label": "INDEX_META_DATA_CREATED_BY",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 19
},
"signature": [
"\"ml-file-data-visualizer\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.MAX_FILE_SIZE",
"type": "string",
"label": "MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"100MB\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 12
},
"signature": [
"104857600"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.MB",
"type": "number",
"label": "MB",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-public.UI_SETTING_MAX_FILE_SIZE",
"type": "string",
"label": "UI_SETTING_MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 8
},
"signature": [
"\"fileUpload:maxFileSize\""
],
"initialIsOpen": false
}
],
"objects": [],
"start": {
"id": "def-public.FileUploadPluginStart",
"type": "Type",
"label": "FileUploadPluginStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/public/plugin.ts",
"lineNumber": 21
},
"signature": [
"FileUploadStartApi"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.Doc",
"type": "Interface",
"label": "Doc",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Doc.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 26
}
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-common.ImportFailure",
"type": "Interface",
"label": "ImportFailure",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ImportFailure.item",
"type": "number",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.ImportFailure.reason",
"type": "string",
"label": "reason",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.ImportFailure.doc",
"type": "CompoundType",
"label": "doc",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportDoc",
"text": "ImportDoc"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-common.ImportResponse",
"type": "Interface",
"label": "ImportResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ImportResponse.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-common.ImportResponse.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.ImportResponse.index",
"type": "string",
"label": "index",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 11
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.ImportResponse.pipelineId",
"type": "string",
"label": "pipelineId",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 12
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.ImportResponse.docCount",
"type": "number",
"label": "docCount",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.ImportResponse.failures",
"type": "Array",
"label": "failures",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.ImportFailure",
"text": "ImportFailure"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.ImportResponse.error",
"type": "Any",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 15
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.ImportResponse.ingestError",
"type": "CompoundType",
"label": "ingestError",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 16
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.IngestPipeline",
"type": "Interface",
"label": "IngestPipeline",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IngestPipeline.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-common.IngestPipeline.processors",
"type": "Array",
"label": "processors",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 54
},
"signature": [
"any[]"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 52
},
"initialIsOpen": false
},
{
"id": "def-common.IngestPipelineWrapper",
"type": "Interface",
"label": "IngestPipelineWrapper",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IngestPipelineWrapper.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 48
}
},
{
"tags": [],
"id": "def-common.IngestPipelineWrapper.pipeline",
"type": "Object",
"label": "pipeline",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 49
},
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
}
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"id": "def-common.Mappings",
"type": "Interface",
"label": "Mappings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Mappings._meta",
"type": "Object",
"label": "_meta",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 39
},
"signature": [
"{ created_by: string; } | undefined"
]
},
{
"tags": [],
"id": "def-common.Mappings.properties",
"type": "Object",
"label": "properties",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 42
},
"signature": [
"{ [key: string]: any; }"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-common.Settings",
"type": "Interface",
"label": "Settings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Settings.pipeline",
"type": "string",
"label": "pipeline",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 32
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.Settings.index",
"type": "string",
"label": "index",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-common.Settings.body",
"type": "Array",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 34
},
"signature": [
"any[]"
]
},
{
"id": "def-common.Settings.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 35
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 31
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "ABSOLUTE_MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 14
},
"signature": [
"1073741274"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FILE_SIZE_DISPLAY_FORMAT",
"type": "string",
"label": "FILE_SIZE_DISPLAY_FORMAT",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 15
},
"signature": [
"\"0,0.[0] b\""
],
"initialIsOpen": false
},
{
"id": "def-common.ImportDoc",
"type": "Type",
"label": "ImportDoc",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/types.ts",
"lineNumber": 29
},
"signature": [
"string | object | ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.Doc",
"text": "Doc"
}
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.INDEX_META_DATA_CREATED_BY",
"type": "string",
"label": "INDEX_META_DATA_CREATED_BY",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 19
},
"signature": [
"\"ml-file-data-visualizer\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_FILE_SIZE",
"type": "string",
"label": "MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 11
},
"signature": [
"\"100MB\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_FILE_SIZE_BYTES",
"type": "number",
"label": "MAX_FILE_SIZE_BYTES",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 12
},
"signature": [
"104857600"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MB",
"type": "number",
"label": "MB",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.UI_SETTING_MAX_FILE_SIZE",
"type": "string",
"label": "UI_SETTING_MAX_FILE_SIZE",
"description": [],
"source": {
"path": "x-pack/plugins/file_upload/common/constants.ts",
"lineNumber": 8
},
"signature": [
"\"fileUpload:maxFileSize\""
],
"initialIsOpen": false
}
],
"objects": []
}
}