kibana/api_docs/file_upload.devdocs.json

1718 lines
No EOL
61 KiB
JSON

{
"id": "fileUpload",
"client": {
"classes": [
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter",
"type": "Class",
"tags": [],
"label": "MessageImporter",
"description": [],
"signature": [
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.MessageImporter",
"text": "MessageImporter"
},
" extends ",
"Importer"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"ImportFactoryOptions"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter._createDocs",
"type": "Function",
"tags": [],
"label": "_createDocs",
"description": [],
"signature": [
"(text: string, isLastPart: boolean, lineLimit?: number | undefined) => ",
"CreateDocsResponse",
"<",
"ImportDocMessage",
">"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter._createDocs.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter._createDocs.$2",
"type": "boolean",
"tags": [],
"label": "isLastPart",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.MessageImporter._createDocs.$3",
"type": "number",
"tags": [],
"label": "lineLimit",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/message_importer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps",
"type": "Interface",
"tags": [],
"label": "FileUploadComponentProps",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.isIndexingTriggered",
"type": "boolean",
"tags": [],
"label": "isIndexingTriggered",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onFileSelect",
"type": "Function",
"tags": [],
"label": "onFileSelect",
"description": [],
"signature": [
"(geojsonFile: GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>, name: string, previewCoverage: number) => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onFileSelect.$1",
"type": "Object",
"tags": [],
"label": "geojsonFile",
"description": [],
"signature": [
"GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onFileSelect.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onFileSelect.$3",
"type": "number",
"tags": [],
"label": "previewCoverage",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onFileClear",
"type": "Function",
"tags": [],
"label": "onFileClear",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.enableImportBtn",
"type": "Function",
"tags": [],
"label": "enableImportBtn",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.disableImportBtn",
"type": "Function",
"tags": [],
"label": "disableImportBtn",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onUploadComplete",
"type": "Function",
"tags": [],
"label": "onUploadComplete",
"description": [],
"signature": [
"(results: ",
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.FileUploadGeoResults",
"text": "FileUploadGeoResults"
},
") => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onUploadComplete.$1",
"type": "Object",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "fileUpload",
"scope": "public",
"docId": "kibFileUploadPluginApi",
"section": "def-public.FileUploadGeoResults",
"text": "FileUploadGeoResults"
}
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadComponentProps.onUploadError",
"type": "Function",
"tags": [],
"label": "onUploadError",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadGeoResults",
"type": "Interface",
"tags": [],
"label": "FileUploadGeoResults",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadGeoResults.indexPatternId",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadGeoResults.geoFieldName",
"type": "string",
"tags": [],
"label": "geoFieldName",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadGeoResults.geoFieldType",
"type": "CompoundType",
"tags": [],
"label": "geoFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_POINT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_SHAPE"
],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadGeoResults.docCount",
"type": "number",
"tags": [],
"label": "docCount",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/lazy_load_bundle/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter",
"type": "Interface",
"tags": [],
"label": "IImporter",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.read",
"type": "Function",
"tags": [],
"label": "read",
"description": [],
"signature": [
"(data: ArrayBuffer) => { success: boolean; }"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.read.$1",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"ArrayBuffer"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport",
"type": "Function",
"tags": [],
"label": "initializeImport",
"description": [],
"signature": [
"(index: string, settings: ",
"IndicesIndexSettings",
", mappings: ",
"MappingTypeMapping",
", pipeline: (",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
},
" | undefined)[], existingIndex?: boolean | undefined) => Promise<",
"InitializeImportResponse",
">"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport.$1",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport.$2",
"type": "CompoundType",
"tags": [],
"label": "settings",
"description": [],
"signature": [
"IndicesIndexSettings"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport.$3",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"MappingTypeMapping"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport.$4",
"type": "Array",
"tags": [],
"label": "pipeline",
"description": [],
"signature": [
"(",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
},
" | undefined)[]"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeImport.$5",
"type": "CompoundType",
"tags": [],
"label": "existingIndex",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeWithoutCreate",
"type": "Function",
"tags": [],
"label": "initializeWithoutCreate",
"description": [],
"signature": [
"(index: string, mappings: ",
"MappingTypeMapping",
", pipelines: ",
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
},
"[]) => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeWithoutCreate.$1",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeWithoutCreate.$2",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"MappingTypeMapping"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initializeWithoutCreate.$3",
"type": "Array",
"tags": [],
"label": "pipelines",
"description": [],
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
},
"[]"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.import",
"type": "Function",
"tags": [],
"label": "import",
"description": [],
"signature": [
"(index: string, ingestPipelineId: string | undefined, setImportProgress: (progress: number) => void) => Promise<",
"ImportResults",
">"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.import.$1",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.import.$2",
"type": "string",
"tags": [],
"label": "ingestPipelineId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.import.$3",
"type": "Function",
"tags": [],
"label": "setImportProgress",
"description": [],
"signature": [
"(progress: number) => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.initialized",
"type": "Function",
"tags": [],
"label": "initialized",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.getIndex",
"type": "Function",
"tags": [],
"label": "getIndex",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.getTimeField",
"type": "Function",
"tags": [],
"label": "getTimeField",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.previewIndexTimeRange",
"type": "Function",
"tags": [],
"label": "previewIndexTimeRange",
"description": [],
"signature": [
"() => Promise<{ start: number | null; end: number | null; }>"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.IImporter.deletePipelines",
"type": "Function",
"tags": [],
"label": "deletePipelines",
"description": [],
"signature": [
"() => Promise<",
"AcknowledgedResponseBase",
"[]>"
],
"path": "x-pack/platform/plugins/private/file_upload/public/importer/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props",
"type": "Interface",
"tags": [],
"label": "Props",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.indexNameError",
"type": "string",
"tags": [],
"label": "indexNameError",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.onIndexNameChange",
"type": "Function",
"tags": [],
"label": "onIndexNameChange",
"description": [],
"signature": [
"(name: string, error?: string | undefined) => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.onIndexNameChange.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.onIndexNameChange.$2",
"type": "string",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.onIndexNameValidationStart",
"type": "Function",
"tags": [],
"label": "onIndexNameValidationStart",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fileUpload",
"id": "def-public.Props.onIndexNameValidationEnd",
"type": "Function",
"tags": [],
"label": "onIndexNameValidationEnd",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/plugins/private/file_upload/public/components/geo_upload_form/index_name_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "fileUpload",
"id": "def-public.FileUploadPluginStart",
"type": "Type",
"tags": [],
"label": "FileUploadPluginStart",
"description": [],
"signature": [
"FileUploadStartApi"
],
"path": "x-pack/platform/plugins/private/file_upload/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "fileUpload",
"id": "def-common.AnalysisResult",
"type": "Interface",
"tags": [],
"label": "AnalysisResult",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.AnalysisResult.results",
"type": "Object",
"tags": [],
"label": "results",
"description": [],
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.FindFileStructureResponse",
"text": "FindFileStructureResponse"
}
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.AnalysisResult.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"FormattedOverrides",
" | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureErrorResponse",
"type": "Interface",
"tags": [],
"label": "FindFileStructureErrorResponse",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureErrorResponse.body",
"type": "Object",
"tags": [],
"label": "body",
"description": [],
"signature": [
"{ statusCode: number; error: string; message: string; attributes?: ErrorAttribute | undefined; }"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureErrorResponse.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse",
"type": "Interface",
"tags": [],
"label": "FindFileStructureResponse",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.charset",
"type": "string",
"tags": [],
"label": "charset",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.has_header_row",
"type": "boolean",
"tags": [],
"label": "has_header_row",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.has_byte_order_marker",
"type": "boolean",
"tags": [],
"label": "has_byte_order_marker",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.format",
"type": "string",
"tags": [],
"label": "format",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.document_type",
"type": "string",
"tags": [],
"label": "document_type",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.field_stats",
"type": "Object",
"tags": [],
"label": "field_stats",
"description": [],
"signature": [
"{ [fieldName: string]: { count: number; cardinality: number; top_hits: { count: number; value: any; }[]; mean_value?: number | undefined; median_value?: number | undefined; max_value?: number | undefined; min_value?: number | undefined; earliest?: string | undefined; latest?: string | undefined; }; }"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.sample_start",
"type": "string",
"tags": [],
"label": "sample_start",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.num_messages_analyzed",
"type": "number",
"tags": [],
"label": "num_messages_analyzed",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [],
"signature": [
"{ properties: { [fieldName: string]: { type: ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".STRING | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".TEXT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".MATCH_ONLY_TEXT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".KEYWORD | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".VERSION | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".BOOLEAN | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".OBJECT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE_NANOS | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_POINT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_SHAPE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".FLOAT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".HALF_FLOAT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".SCALED_FLOAT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DOUBLE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".INTEGER | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".LONG | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".SHORT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".UNSIGNED_LONG | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".AGGREGATE_METRIC_DOUBLE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".FLOAT_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DOUBLE_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".INTEGER_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".LONG_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".NESTED | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".BYTE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".IP | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".IP_RANGE | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".ATTACHMENT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".TOKEN_COUNT | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".MURMUR3 | ",
{
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".HISTOGRAM; format?: string | undefined; }; }; }"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.ingest_pipeline",
"type": "Object",
"tags": [],
"label": "ingest_pipeline",
"description": [],
"signature": [
{
"pluginId": "fileUpload",
"scope": "common",
"docId": "kibFileUploadPluginApi",
"section": "def-common.IngestPipeline",
"text": "IngestPipeline"
}
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.quote",
"type": "string",
"tags": [],
"label": "quote",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.delimiter",
"type": "string",
"tags": [],
"label": "delimiter",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.need_client_timezone",
"type": "boolean",
"tags": [],
"label": "need_client_timezone",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.num_lines_analyzed",
"type": "number",
"tags": [],
"label": "num_lines_analyzed",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.column_names",
"type": "Array",
"tags": [],
"label": "column_names",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.explanation",
"type": "Array",
"tags": [],
"label": "explanation",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.grok_pattern",
"type": "string",
"tags": [],
"label": "grok_pattern",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.multiline_start_pattern",
"type": "string",
"tags": [],
"label": "multiline_start_pattern",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.exclude_lines_pattern",
"type": "string",
"tags": [],
"label": "exclude_lines_pattern",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.java_timestamp_formats",
"type": "Array",
"tags": [],
"label": "java_timestamp_formats",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.joda_timestamp_formats",
"type": "Array",
"tags": [],
"label": "joda_timestamp_formats",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.timestamp_field",
"type": "string",
"tags": [],
"label": "timestamp_field",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.should_trim_fields",
"type": "CompoundType",
"tags": [],
"label": "should_trim_fields",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.FindFileStructureResponse.ecs_compatibility",
"type": "string",
"tags": [],
"label": "ecs_compatibility",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.IngestPipeline",
"type": "Interface",
"tags": [],
"label": "IngestPipeline",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.IngestPipeline.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.IngestPipeline.processors",
"type": "Array",
"tags": [],
"label": "processors",
"description": [],
"signature": [
"any[]"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.IngestPipeline.isManaged",
"type": "CompoundType",
"tags": [],
"label": "isManaged",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.IngestPipeline.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.InputOverrides",
"type": "Interface",
"tags": [],
"label": "InputOverrides",
"description": [],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.InputOverrides.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: string | undefined",
"description": [],
"signature": [
"[key: string]: string | undefined"
],
"path": "x-pack/platform/plugins/private/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}