{ "id": "files", "client": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "files", "id": "def-public.FilesClient", "type": "Interface", "tags": [], "label": "FilesClient", "description": [ "\nA client that can be used to manage a specific {@link FileKind}." ], "signature": [ { "pluginId": "files", "scope": "public", "docId": "kibFilesPluginApi", "section": "def-public.FilesClient", "text": "FilesClient" }, " extends GlobalEndpoints" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.create", "type": "Function", "tags": [], "label": "create", "description": [ "\nCreate a new file object with the provided metadata.\n" ], "signature": [ "(args: { name: string; alt?: string | undefined; meta?: Record | undefined; mimeType?: string | undefined; } & { kind: string; }) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.create.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- create file args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nDelete a file object and all associated share and content objects.\n" ], "signature": [ "(args: { id: string; } & { kind: string; }) => Promise<{ ok: true; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.delete.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- delete file args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.getById", "type": "Function", "tags": [], "label": "getById", "description": [ "\nGet a file object by ID.\n" ], "signature": [ "(args: { id: string; } & { kind: string; }) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.getById.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- get file by ID args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList all file objects, of a given {@link FileKind}.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" }, " & { kind: string; }) => Promise<{ files: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.list.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- list files args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.update", "type": "Function", "tags": [], "label": "update", "description": [ "\nUpdate a set of of metadata values of the file object.\n" ], "signature": [ "(args: { name?: string | undefined; alt?: string | undefined; meta?: Record | undefined; } & { id: string; } & { kind: string; }) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.update.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- update file args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.upload", "type": "Function", "tags": [], "label": "upload", "description": [ "\nStream the contents of the file to Kibana server for storage.\n" ], "signature": [ "(args: { body: unknown; } & { id: string; } & { kind: string; }) => Promise<{ ok: true; size: number; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.upload.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- upload file args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.download", "type": "Function", "tags": [], "label": "download", "description": [ "\nStream a download of the file object's content.\n" ], "signature": [ "(args: { id: string; fileName?: string | undefined; } & { kind: string; }) => Promise" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.download.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- download file args" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.getDownloadHref", "type": "Function", "tags": [], "label": "getDownloadHref", "description": [ "\nGet a string for downloading a file that can be passed to a button element's\nhref for download." ], "signature": [ "(file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, ") => string" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.getDownloadHref.$1", "type": "Object", "tags": [], "label": "file", "description": [], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-public.FilesClient.share", "type": "Function", "tags": [ "note" ], "label": "share", "description": [ "\nShare a file by creating a new file share instance.\n" ], "signature": [ "(args: { validUntil?: number | undefined; name?: string | undefined; } & { fileId: string; } & { kind: string; }) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSONWithToken", "text": "FileShareJSONWithToken" }, ">" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.share.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- File share arguments" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.unshare", "type": "Function", "tags": [], "label": "unshare", "description": [ "\nDelete a file share instance.\n" ], "signature": [ "(args: { id: string; } & { kind: string; }) => Promise<{ ok: true; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.unshare.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- File unshare arguments" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.getShare", "type": "Function", "tags": [], "label": "getShare", "description": [ "\nGet a file share instance.\n" ], "signature": [ "(args: { id: string; } & { kind: string; }) => Promise<{ share: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.getShare.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- Get file share arguments" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-public.FilesClient.listShares", "type": "Function", "tags": [], "label": "listShares", "description": [ "\nList all file shares. Optionally scoping to a specific\nfile.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" }, " & { forFileId?: string | undefined; } & { kind: string; }) => Promise<{ shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }>" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-public.FilesClient.listShares.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [ "- Get file share arguments" ], "signature": [ "E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"] & { kind: string; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-public.FilesClientFactory", "type": "Interface", "tags": [], "label": "FilesClientFactory", "description": [ "\nA factory for creating a {@link ScopedFilesClient}" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-public.FilesClientFactory.asUnscoped", "type": "Function", "tags": [], "label": "asUnscoped", "description": [ "\nCreate a files client." ], "signature": [ "() => ", { "pluginId": "files", "scope": "public", "docId": "kibFilesPluginApi", "section": "def-public.FilesClient", "text": "FilesClient" } ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "files", "id": "def-public.FilesClientFactory.asScoped", "type": "Function", "tags": [], "label": "asScoped", "description": [ "\nCreate a {@link ScopedFileClient} for a given {@link FileKind}.\n" ], "signature": [ "(fileKind: string) => ", { "pluginId": "files", "scope": "public", "docId": "kibFilesPluginApi", "section": "def-public.ScopedFilesClient", "text": "ScopedFilesClient" } ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-public.FilesClientFactory.asScoped.$1", "type": "string", "tags": [], "label": "fileKind", "description": [ "- The {@link FileKind } to create a client for." ], "signature": [ "string" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "files", "id": "def-public.FilesClientResponses", "type": "Type", "tags": [], "label": "FilesClientResponses", "description": [], "signature": [ "{ create: { file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }; delete: { ok: true; }; getById: { file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }; list: { files: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]; }; update: { file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }; upload: { ok: true; size: number; }; download: any; getDownloadHref: string; share: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, " & { token: string; }; unshare: { ok: true; }; getShare: { share: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "; }; listShares: { shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }; getMetrics: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FilesMetrics", "text": "FilesMetrics" }, "; publicDownload: any; find: { files: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]; }; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-public.ScopedFilesClient", "type": "Type", "tags": [], "label": "ScopedFilesClient", "description": [ "\nA files client that is scoped to a specific {@link FileKind}.\n\nMore convenient if you want to re-use the same client for the same file kind\nand not specify the kind every time." ], "signature": [ "{ create: (arg: Omit<{ name: string; alt?: string | undefined; meta?: Record | undefined; mimeType?: string | undefined; } & { kind: string; }, \"kind\">) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>; delete: (arg: Omit<{ id: string; } & { kind: string; }, \"kind\">) => Promise<{ ok: true; }>; getById: (arg: Omit<{ id: string; } & { kind: string; }, \"kind\">) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>; list: (arg?: Omit<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" }, " & { kind: string; }, \"kind\"> | undefined) => Promise<{ files: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]; }>; update: (arg: Omit<{ name?: string | undefined; alt?: string | undefined; meta?: Record | undefined; } & { id: string; } & { kind: string; }, \"kind\">) => Promise<{ file: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "; }>; upload: (arg: Omit<{ body: unknown; } & { id: string; } & { kind: string; }, \"kind\">) => Promise<{ ok: true; size: number; }>; download: (arg: Omit<{ id: string; fileName?: string | undefined; } & { kind: string; }, \"kind\">) => Promise; getDownloadHref: (arg: Omit<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, ", \"kind\">) => string; share: (arg: Omit<{ validUntil?: number | undefined; name?: string | undefined; } & { fileId: string; } & { kind: string; }, \"kind\">) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSONWithToken", "text": "FileShareJSONWithToken" }, ">; unshare: (arg: Omit<{ id: string; } & { kind: string; }, \"kind\">) => Promise<{ ok: true; }>; getShare: (arg: Omit<{ id: string; } & { kind: string; }, \"kind\">) => Promise<{ share: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "; }>; listShares: (arg: Omit<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" }, " & { forFileId?: string | undefined; } & { kind: string; }, \"kind\">) => Promise<{ shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }>; getMetrics: (arg: Omit) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FilesMetrics", "text": "FilesMetrics" }, ">; publicDownload: (arg: Omit<{ fileName?: string | undefined; } & { token: string; }, \"kind\">) => Promise; find: (arg: Omit<{ kind?: string[] | undefined; name?: string[] | undefined; meta?: {} | undefined; extension?: string[] | undefined; status?: string[] | undefined; } & ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" }, ", \"kind\">) => Promise<{ files: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]; }>; }" ], "path": "x-pack/plugins/files/public/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "start": { "parentPluginId": "files", "id": "def-public.FilesStart", "type": "Type", "tags": [], "label": "FilesStart", "description": [], "signature": [ { "pluginId": "files", "scope": "public", "docId": "kibFilesPluginApi", "section": "def-public.FilesSetup", "text": "FilesSetup" } ], "path": "x-pack/plugins/files/public/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [ { "parentPluginId": "files", "id": "def-server.createEsFileClient", "type": "Function", "tags": [ "note" ], "label": "createEsFileClient", "description": [ "\nA utility function for creating an instance of {@link FileClient}\nthat will speak with ES indices only for file functionality.\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.CreateEsFileClientArgs", "text": "CreateEsFileClientArgs" }, ") => ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileClient", "text": "FileClient" } ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.createEsFileClient.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- See {@link CreateEsFileClientArgs }" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.CreateEsFileClientArgs", "text": "CreateEsFileClientArgs" } ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs", "type": "Interface", "tags": [], "label": "CreateEsFileClientArgs", "description": [ "\nArguments to create an ES file client." ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs.metadataIndex", "type": "string", "tags": [], "label": "metadataIndex", "description": [ "\nThe name of the ES index that will store file metadata." ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs.blobStorageIndex", "type": "string", "tags": [], "label": "blobStorageIndex", "description": [ "\nThe name of the ES index that will store file contents." ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs.elasticsearchClient", "type": "Object", "tags": [], "label": "elasticsearchClient", "description": [ "\nAn elasticsearch client that will be used to interact with the cluster" ], "signature": [ "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetResponse", ">; (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetResponse", ", unknown>>; (this: That, params: ", "GetRequest", " | ", "GetRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetResponse", ">; }; delete: { (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "DeleteRequest", " | ", "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; cluster: ", "default", "; eql: ", "default", "; search: { >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchResponse", ">; >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchResponse", ", unknown>>; >(this: That, params?: ", "SearchRequest", " | ", "SearchRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchResponse", ">; }; create: { (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "CreateRequest", " | ", "CreateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; monitoring: ", "default", "; security: ", "default", "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "WriteResponseBase", ">; (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "WriteResponseBase", ", unknown>>; (this: That, params: ", "IndexRequest", " | ", "IndexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", ">; }; update: { (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateResponse", ">; (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateResponse", ", unknown>>; (this: That, params: ", "UpdateRequest", " | ", "UpdateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; helpers: ", "default", "; child: (opts: ", "ClientOptions", ") => ", "default", "; Internal: ", "default", "; asyncSearch: ", "default", "; autoscaling: ", "default", "; bulk: { (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "BulkResponse", ">; (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "BulkResponse", ", unknown>>; (this: That, params: ", "BulkRequest", " | ", "BulkRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "BulkResponse", ">; }; cat: ", "default", "; ccr: ", "default", "; clearScroll: { (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClearScrollResponse", ">; (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClearScrollResponse", ", unknown>>; (this: That, params?: ", "ClearScrollRequest", " | ", "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClearScrollResponse", ">; }; closePointInTime: { (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ClosePointInTimeResponse", ">; (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ClosePointInTimeResponse", ", unknown>>; (this: That, params: ", "ClosePointInTimeRequest", " | ", "ClosePointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ClosePointInTimeResponse", ">; }; count: { (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "CountResponse", ">; (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "CountResponse", ", unknown>>; (this: That, params?: ", "CountRequest", " | ", "CountRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "CountResponse", ">; }; danglingIndices: ", "default", "; deleteByQuery: { (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "DeleteByQueryResponse", ">; (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "DeleteByQueryResponse", ", unknown>>; (this: That, params: ", "DeleteByQueryRequest", " | ", "DeleteByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "DeleteByQueryResponse", ">; }; deleteByQueryRethrottle: { (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TasksTaskListResponseBase", ">; (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TasksTaskListResponseBase", ", unknown>>; (this: That, params: ", "DeleteByQueryRethrottleRequest", " | ", "DeleteByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TasksTaskListResponseBase", ">; }; deleteScript: { (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "DeleteScriptRequest", " | ", "DeleteScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; enrich: ", "default", "; exists: { (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsRequest", " | ", "ExistsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; existsSource: { (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "ExistsSourceRequest", " | ", "ExistsSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; explain: { (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ExplainResponse", ">; (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ExplainResponse", ", unknown>>; (this: That, params: ", "ExplainRequest", " | ", "ExplainRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ExplainResponse", ">; }; features: ", "default", "; fieldCaps: { (this: That, params: ", "FieldCapsRequest", " | ", "FieldCapsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "FieldCapsResponse", ">; (this: That, params: ", "FieldCapsRequest", " | ", "FieldCapsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "FieldCapsResponse", ", unknown>>; (this: That, params: ", "FieldCapsRequest", " | ", "FieldCapsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "FieldCapsResponse", ">; }; fleet: ", "default", "; getScript: { (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptResponse", ">; (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptResponse", ", unknown>>; (this: That, params: ", "GetScriptRequest", " | ", "GetScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptResponse", ">; }; getScriptContext: { (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptContextResponse", ">; (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptContextResponse", ", unknown>>; (this: That, params?: ", "GetScriptContextRequest", " | ", "GetScriptContextRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptContextResponse", ">; }; getScriptLanguages: { (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "GetScriptLanguagesResponse", ", unknown>>; (this: That, params?: ", "GetScriptLanguagesRequest", " | ", "GetScriptLanguagesRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "GetScriptLanguagesResponse", ">; }; getSource: { (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "GetSourceRequest", " | ", "GetSourceRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; graph: ", "default", "; ilm: ", "default", "; indices: ", "default", "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "InfoResponse", ">; (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "InfoResponse", ", unknown>>; (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "InfoResponse", ">; }; ingest: ", "default", "; knnSearch: { (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "KnnSearchResponse", ">; (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "KnnSearchResponse", ", unknown>>; (this: That, params: ", "KnnSearchRequest", " | ", "KnnSearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "KnnSearchResponse", ">; }; license: ", "default", "; logstash: ", "default", "; mget: { (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MgetResponse", ">; (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MgetResponse", ", unknown>>; (this: That, params?: ", "MgetRequest", " | ", "MgetRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MgetResponse", ">; }; migration: ", "default", "; ml: ", "default", "; msearch: { >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchResponse", ">; >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchResponse", ", unknown>>; >(this: That, params: ", "MsearchRequest", " | ", "MsearchRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchResponse", ">; }; msearchTemplate: { >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MsearchTemplateResponse", ">; >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MsearchTemplateResponse", ", unknown>>; >(this: That, params: ", "MsearchTemplateRequest", " | ", "MsearchTemplateRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "MsearchTemplateResponse", ">; }; mtermvectors: { (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "MtermvectorsResponse", ">; (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "MtermvectorsResponse", ", unknown>>; (this: That, params?: ", "MtermvectorsRequest", " | ", "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", ">; }; nodes: ", "default", "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "OpenPointInTimeResponse", ">; (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "OpenPointInTimeResponse", ", unknown>>; (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", ">; }; ping: { (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params?: ", "PingRequest", " | ", "PingRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "AcknowledgedResponseBase", ">; (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "AcknowledgedResponseBase", ", unknown>>; (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "AcknowledgedResponseBase", ">; }; rankEval: { (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RankEvalResponse", ">; (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RankEvalResponse", ", unknown>>; (this: That, params: ", "RankEvalRequest", " | ", "RankEvalRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "RankEvalResponse", ">; }; reindex: { (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexResponse", ">; (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexResponse", ", unknown>>; (this: That, params: ", "ReindexRequest", " | ", "ReindexRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexResponse", ">; }; reindexRethrottle: { (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ReindexRethrottleResponse", ">; (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ReindexRethrottleResponse", ", unknown>>; (this: That, params: ", "ReindexRethrottleRequest", " | ", "ReindexRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ReindexRethrottleResponse", ">; }; renderSearchTemplate: { (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "RenderSearchTemplateResponse", ", unknown>>; (this: That, params?: ", "RenderSearchTemplateRequest", " | ", "RenderSearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "RenderSearchTemplateResponse", ">; }; rollup: ", "default", "; scriptsPainlessExecute: { (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScriptsPainlessExecuteResponse", ", unknown>>; (this: That, params?: ", "ScriptsPainlessExecuteRequest", " | ", "ScriptsPainlessExecuteRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScriptsPainlessExecuteResponse", ">; }; scroll: { >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "ScrollResponse", ">; >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "ScrollResponse", ", unknown>>; >(this: That, params: ", "ScrollRequest", " | ", "ScrollRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "ScrollResponse", ">; }; searchMvt: { (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise; (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", ">; (this: That, params: ", "SearchMvtRequest", " | ", "SearchMvtRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise; }; searchShards: { (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchShardsResponse", ">; (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchShardsResponse", ", unknown>>; (this: That, params?: ", "SearchShardsRequest", " | ", "SearchShardsRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchShardsResponse", ">; }; searchTemplate: { (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "SearchTemplateResponse", ">; (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "SearchTemplateResponse", ", unknown>>; (this: That, params?: ", "SearchTemplateRequest", " | ", "SearchTemplateRequest", " | undefined, options?: ", "TransportRequestOptions", " | undefined): Promise<", "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", "; shutdown: ", "default", "; slm: ", "default", "; snapshot: ", "default", "; sql: ", "default", "; ssl: ", "default", "; tasks: ", "default", "; termsEnum: { (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermsEnumResponse", ">; (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermsEnumResponse", ", unknown>>; (this: That, params: ", "TermsEnumRequest", " | ", "TermsEnumRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermsEnumResponse", ">; }; termvectors: { (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "TermvectorsResponse", ">; (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "TermvectorsResponse", ", unknown>>; (this: That, params: ", "TermvectorsRequest", " | ", "TermvectorsRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "TermvectorsResponse", ">; }; textStructure: ", "default", "; transform: ", "default", "; updateByQuery: { (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryResponse", ">; (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRequest", " | ", "UpdateByQueryRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryResponse", ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithOutMeta", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptionsWithMeta", " | undefined): Promise<", "TransportResult", "<", "UpdateByQueryRethrottleResponse", ", unknown>>; (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", "UpdateByQueryRethrottleRequest", ", options?: ", "TransportRequestOptions", " | undefined): Promise<", "UpdateByQueryRethrottleResponse", ">; }; watcher: ", "default", "; xpack: ", "default", "; }" ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs.maxSizeBytes", "type": "number", "tags": [], "label": "maxSizeBytes", "description": [ "\nThe maximum file size to be write" ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateEsFileClientArgs.logger", "type": "Object", "tags": [], "label": "logger", "description": [ "\nA logger for debuggin purposes" ], "signature": [ "Logger" ], "path": "x-pack/plugins/files/server/file_client/create_es_file_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.CreateFileArgs", "type": "Interface", "tags": [], "label": "CreateFileArgs", "description": [ "\nArguments to create a new file." ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.CreateFileArgs", "text": "CreateFileArgs" }, "" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.CreateFileArgs.name", "type": "string", "tags": [], "label": "name", "description": [ "\nFile name" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateFileArgs.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nFile kind, must correspond to a registered {@link FileKind}." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateFileArgs.alt", "type": "string", "tags": [], "label": "alt", "description": [ "\nAlternate text for accessibility and display purposes." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateFileArgs.meta", "type": "Uncategorized", "tags": [], "label": "meta", "description": [ "\nCustom metadata like tags or identifiers for the file." ], "signature": [ "Meta | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateFileArgs.mime", "type": "string", "tags": [], "label": "mime", "description": [ "\nThe MIME type of the file." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.CreateShareArgs", "type": "Interface", "tags": [], "label": "CreateShareArgs", "description": [ "\nArguments for a creating a file share" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.CreateShareArgs.name", "type": "string", "tags": [], "label": "name", "description": [ "\nOptionally provide a name for this file share instance" ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateShareArgs.validUntil", "type": "number", "tags": [ "note" ], "label": "validUntil", "description": [ "\nOptionally set an expiration date as unix timestamp for this file share instance\n" ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.CreateShareArgs.file", "type": "Object", "tags": [], "label": "file", "description": [ "\nThe file object to create the share for" ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, "" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.DeleteArg", "type": "Interface", "tags": [], "label": "DeleteArg", "description": [], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.DeleteArg.id", "type": "string", "tags": [ "note" ], "label": "id", "description": [ "\nUnique ID of file metadata to delete\n" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.DeleteFileArgs", "type": "Interface", "tags": [], "label": "DeleteFileArgs", "description": [ "\nArguments to delete a file." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.DeleteFileArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nFile ID." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.DeleteFileArgs.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nFile kind, must correspond to a registered {@link FileKind}." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.DeleteForFileArgs", "type": "Interface", "tags": [], "label": "DeleteForFileArgs", "description": [ "\nDelete file shares for file arguments." ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.DeleteForFileArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nThe file id to delete the shares for." ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileClient", "type": "Interface", "tags": [], "label": "FileClient", "description": [ "\nWraps the {@link FileMetadataClient} and {@link BlobStorageClient} client\nto provide basic file CRUD functionality.\n\nFor now this is just a shallow type of the implementation for export purposes." ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "See {@link FileMetadata.FileKind}." ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FileClient.create", "type": "Function", "tags": [], "label": "create", "description": [ "\nSee {@link FileMetadataClient.create}.\n" ], "signature": [ "(arg: ", "CreateArgs", ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.create.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arg to create a file." ], "signature": [ "CreateArgs" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nSee {@link FileMetadataClient.get}\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetArg", "text": "GetArg" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.get.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Argument to get a file" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetArg", "text": "GetArg" } ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.update", "type": "Function", "tags": [], "label": "update", "description": [ "\n{@link FileMetadataClient.update}\n" ], "signature": [ "(id: string, metadata: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.UpdatableFileMetadata", "text": "UpdatableFileMetadata" }, ") => Promise" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.update.$1", "type": "string", "tags": [], "label": "id", "description": [ "- File id" ], "signature": [ "string" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "files", "id": "def-server.FileClient.update.$2", "type": "Object", "tags": [], "label": "metadata", "description": [ "- new file metadata" ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.UpdatableFileMetadata", "text": "UpdatableFileMetadata" }, "" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nDelete a file." ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteArgs", "text": "DeleteArgs" }, ") => Promise" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.delete.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Argument to delete a file" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteArgs", "text": "DeleteArgs" } ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nSee {@link FileMetadataClient.list}\n" ], "signature": [ "(arg?: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArg", "text": "ListArg" }, " | undefined) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, "[]>" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.list.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Argument to list files" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArg", "text": "ListArg" }, " | undefined" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.find", "type": "Function", "tags": [], "label": "find", "description": [ "\nSee {@link FileMetadataClient.find}.\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, "[]>" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.find.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Argument to find files" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" } ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.share", "type": "Function", "tags": [ "note" ], "label": "share", "description": [ "\nCreate a file share instance for this file.\n" ], "signature": [ "(args: ", "ShareArgs", ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSONWithToken", "text": "FileShareJSONWithToken" }, ">" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.share.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- Arguments to create a file share" ], "signature": [ "ShareArgs" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileClient.unshare", "type": "Function", "tags": [ "note" ], "label": "unshare", "description": [ "\nCreate a file share instance for this file.\n" ], "signature": [ "(args: IdArg) => Promise" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.unshare.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- Arguments to remove a file share" ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-server.FileClient.listShares", "type": "Function", "tags": [ "note" ], "label": "listShares", "description": [ "\nCreate a file share instance for this file.\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" }, ") => Promise<{ shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }>" ], "path": "x-pack/plugins/files/server/file_client/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileClient.listShares.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arguments to remove a file share" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" } ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileDescriptor", "type": "Interface", "tags": [], "label": "FileDescriptor", "description": [ "\nMeta description of a file." ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, "" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileDescriptor.id", "type": "string", "tags": [], "label": "id", "description": [ "\nUnique ID of a file, used to locate a file." ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FileDescriptor.metadata", "type": "CompoundType", "tags": [], "label": "metadata", "description": [ "\nThe file's metadata." ], "signature": [ "Required> & ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.BaseFileMetadata", "text": "BaseFileMetadata" }, " & { FileKind: string; Meta?: M | undefined; }" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient", "type": "Interface", "tags": [], "label": "FileMetadataClient", "description": [ "\nAn abstraction of storage implementation of file object's (i.e., metadata)" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.create", "type": "Function", "tags": [], "label": "create", "description": [ "\nCreate an instance of file metadata\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, ") => Promise<", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, ">" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.create.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Provide an ID and metadata" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, "" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nGet file metadata\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetArg", "text": "GetArg" }, ") => Promise<", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, ">" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.get.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arguments to retrieve file metadata" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetArg", "text": "GetArg" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.update", "type": "Function", "tags": [], "label": "update", "description": [ "\nThe file metadata to update\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" }, ") => Promise<", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, ">" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.update.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arguments to update file metadata" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" }, "" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nDelete an instance of file metadata\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteArg", "text": "DeleteArg" }, ") => Promise" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.delete.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arguments to delete file metadata" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteArg", "text": "DeleteArg" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList all instances of metadata for a file kind.\n" ], "signature": [ "(arg?: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArg", "text": "ListArg" }, " | undefined) => Promise<", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, "[]>" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.list.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Arguments to list file metadata" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArg", "text": "ListArg" }, " | undefined" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.find", "type": "Function", "tags": [], "label": "find", "description": [ "\nSearch for a set of file kind instances that match the filters.\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" }, ") => Promise<", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileDescriptor", "text": "FileDescriptor" }, "[]>" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.find.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Filters and other settings to match against" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileMetadataClient.getUsageMetrics", "type": "Function", "tags": [], "label": "getUsageMetrics", "description": [ "\nPrepare a set of metrics based on the file metadata.\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetUsageMetricsArgs", "text": "GetUsageMetricsArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FilesMetrics", "text": "FilesMetrics" }, ">" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileMetadataClient.getUsageMetrics.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- Argument to get usage metrics" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetUsageMetricsArgs", "text": "GetUsageMetricsArgs" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileServiceFactory", "type": "Interface", "tags": [], "label": "FileServiceFactory", "description": [ "\nA simple interface for getting an instance of {@link FileServiceStart}" ], "path": "x-pack/plugins/files/server/file_service/file_service_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceFactory.asScoped", "type": "Function", "tags": [], "label": "asScoped", "description": [ "\nGet a file service instance that is scoped to the current user request.\n" ], "signature": [ "(req: ", "KibanaRequest", ") => ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileServiceStart", "text": "FileServiceStart" } ], "path": "x-pack/plugins/files/server/file_service/file_service_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceFactory.asScoped.$1", "type": "Object", "tags": [], "label": "req", "description": [ "- the Kibana request to scope the service to" ], "signature": [ "KibanaRequest", "" ], "path": "x-pack/plugins/files/server/file_service/file_service_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceFactory.asInternal", "type": "Function", "tags": [ "note" ], "label": "asInternal", "description": [ "\nGet a file service instance that is scoped to the internal user.\n" ], "signature": [ "() => ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileServiceStart", "text": "FileServiceStart" } ], "path": "x-pack/plugins/files/server/file_service/file_service_factory.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileServiceStart", "type": "Interface", "tags": [], "label": "FileServiceStart", "description": [ "\nPublic file service interface." ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.create", "type": "Function", "tags": [], "label": "create", "description": [ "\nCreate a new file.\n\nOnce created, the file content can be uploaded. See {@link File}.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.CreateFileArgs", "text": "CreateFileArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.create.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- create file arg" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.CreateFileArgs", "text": "CreateFileArgs" }, "" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.update", "type": "Function", "tags": [], "label": "update", "description": [ "\nUpdate updatable file attributes like name and meta.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateFileArgs", "text": "UpdateFileArgs" }, ") => Promise" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.update.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- update file args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateFileArgs", "text": "UpdateFileArgs" } ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nDelete a file.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteFileArgs", "text": "DeleteFileArgs" }, ") => Promise" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.delete.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- delete file args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.DeleteFileArgs", "text": "DeleteFileArgs" } ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.getById", "type": "Function", "tags": [], "label": "getById", "description": [ "\nGet a file by ID. Will throw if file cannot be found.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetByIdArgs", "text": "GetByIdArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.getById.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- get file by ID args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.GetByIdArgs", "text": "GetByIdArgs" } ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.find", "type": "Function", "tags": [], "label": "find", "description": [ "\nFind files given a set of parameters.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "[]>" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.find.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- find files args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" } ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList all files of specific file kind.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListFilesArgs", "text": "ListFilesArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, "[]>" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.list.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- list files args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListFilesArgs", "text": "ListFilesArgs" } ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.getShareObject", "type": "Function", "tags": [], "label": "getShareObject", "description": [ "\nGet an instance of a share object\n" ], "signature": [ "(arg: IdArg) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, ">" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.getShareObject.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- get share args" ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.listShareObjects", "type": "Function", "tags": [], "label": "listShareObjects", "description": [ "\nList share objects\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" }, ") => Promise<{ shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }>" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.listShareObjects.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- list share objects args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" } ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.updateShareObject", "type": "Function", "tags": [], "label": "updateShareObject", "description": [ "\nUpdate an instance of a share object\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShare", "text": "FileShare" }, " & { id: string; }>" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.updateShareObject.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- update share args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" } ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.deleteShareObject", "type": "Function", "tags": [], "label": "deleteShareObject", "description": [ "\nDelete a share instance\n" ], "signature": [ "(args: IdArg) => Promise" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.deleteShareObject.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- delete share args" ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.getUsageMetrics", "type": "Function", "tags": [], "label": "getUsageMetrics", "description": [ "\nGet the current usage metrics for all storage media.\n\nReturns diagnostics or `undefined` if metrics could not be retrieved." ], "signature": [ "() => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FilesMetrics", "text": "FilesMetrics" }, ">" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileServiceStart.getByToken", "type": "Function", "tags": [], "label": "getByToken", "description": [ "\nGet a file by a secret token.\n" ], "signature": [ "(token: string) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileServiceStart.getByToken.$1", "type": "string", "tags": [], "label": "token", "description": [ "- secret token" ], "signature": [ "string" ], "path": "x-pack/plugins/files/server/file_service/file_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FileShareServiceStart", "type": "Interface", "tags": [], "label": "FileShareServiceStart", "description": [ "\nWe only expose functionality here that do not require you to have a {@link File}\ninstance loaded." ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nGet a share instance\n" ], "signature": [ "(arg: IdArg) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, ">" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.get.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- the arguments to get the share instance" ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.list", "type": "Function", "tags": [], "label": "list", "description": [ "\nList share objects\n" ], "signature": [ "(arg: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" }, ") => Promise<{ shares: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]; }>" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.list.$1", "type": "Object", "tags": [], "label": "arg", "description": [ "- the arguments to list share objects" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" } ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.update", "type": "Function", "tags": [], "label": "update", "description": [ "\nUpdate a share instance.\n" ], "signature": [ "(args: ", { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" }, ") => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShare", "text": "FileShare" }, " & { id: string; }>" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.update.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- the arguments to update a share instance" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" } ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nDelete a share instance.\n" ], "signature": [ "(args: IdArg) => Promise" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FileShareServiceStart.delete.$1", "type": "Object", "tags": [], "label": "args", "description": [ "- the arguments to delete a share instance" ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FindArg", "type": "Interface", "tags": [], "label": "FindArg", "description": [], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindArg", "text": "FindArg" }, " extends ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FindArg.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nThe file kind to scope this query to" ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.FindFileArgs", "type": "Interface", "tags": [ "note" ], "label": "FindFileArgs", "description": [ "\nArguments to filter for files.\n" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FindFileArgs", "text": "FindFileArgs" }, " extends ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" } ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FindFileArgs.kind", "type": "Array", "tags": [], "label": "kind", "description": [ "\nFile kind(s), see {@link FileKind}." ], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FindFileArgs.name", "type": "Array", "tags": [], "label": "name", "description": [ "\nFile name(s)." ], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FindFileArgs.extension", "type": "Array", "tags": [], "label": "extension", "description": [ "\nFile extension(s)." ], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FindFileArgs.status", "type": "Array", "tags": [], "label": "status", "description": [ "\nFile status(es)." ], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.FindFileArgs.meta", "type": "Object", "tags": [], "label": "meta", "description": [ "\nFile metadata values. These values are governed by the consumer." ], "signature": [ "Record | undefined" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.GetArg", "type": "Interface", "tags": [], "label": "GetArg", "description": [ "\nGet a file" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.GetArg.id", "type": "string", "tags": [], "label": "id", "description": [ "\nUnique ID of file metadata" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.GetByIdArgs", "type": "Interface", "tags": [], "label": "GetByIdArgs", "description": [ "\nArguments to get a file by ID." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.GetByIdArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nFile ID." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.GetByIdArgs.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nFile kind, must correspond to a registered {@link FileKind}." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.GetUsageMetricsArgs", "type": "Interface", "tags": [], "label": "GetUsageMetricsArgs", "description": [ "\nArgs to get usage metrics" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.GetUsageMetricsArgs.ES_FIXED_SIZE_INDEX_BLOB_STORE", "type": "Object", "tags": [], "label": "[ES_FIXED_SIZE_INDEX_BLOB_STORE]", "description": [ "\nThe ES backed fixed size storage" ], "signature": [ "{ capacity: number; }" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.ListArg", "type": "Interface", "tags": [], "label": "ListArg", "description": [], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArg", "text": "ListArg" }, " extends ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" } ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.ListArg.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nThe file kind to scope this query to" ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.ListArgs", "type": "Interface", "tags": [], "label": "ListArgs", "description": [ "\nArguments for listing file shares." ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListArgs", "text": "ListArgs" }, " extends ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" } ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.ListArgs.fileId", "type": "string", "tags": [], "label": "fileId", "description": [ "\nThe file ID for scope the list to." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.ListFilesArgs", "type": "Interface", "tags": [], "label": "ListFilesArgs", "description": [ "\nArguments list files." ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.ListFilesArgs", "text": "ListFilesArgs" }, " extends ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.Pagination", "text": "Pagination" } ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.ListFilesArgs.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nFile kind, must correspond to a registered {@link FileKind}." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.UpdateArgs", "type": "Interface", "tags": [], "label": "UpdateArgs", "description": [ "\nUpdate a file args" ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.UpdateArgs", "text": "UpdateArgs" }, "" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.UpdateArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nA unique file ID." ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.UpdateArgs.metadata", "type": "Object", "tags": [], "label": "metadata", "description": [ "\nThe file's metadata." ], "signature": [ "{ name?: string | undefined; created?: string | undefined; Status?: \"AWAITING_UPLOAD\" | \"UPLOADING\" | \"READY\" | \"UPLOAD_ERROR\" | \"DELETED\" | undefined; Updated?: string | undefined; mime_type?: string | undefined; size?: number | undefined; hash?: { [hashName: string]: string | undefined; md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; extension?: string | undefined; Alt?: string | undefined; ChunkSize?: number | undefined; Compression?: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileCompression", "text": "FileCompression" }, " | undefined; FileKind?: string | undefined; Meta?: M | undefined; }" ], "path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.UpdateArgs", "type": "Interface", "tags": [], "label": "UpdateArgs", "description": [ "\nUpdate file share arguments." ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.UpdateArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nThe file share ID." ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.UpdateArgs.attributes", "type": "Object", "tags": [], "label": "attributes", "description": [ "\nThe updated attributes to store." ], "signature": [ "{ name?: string | undefined; }" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.UpdateFileArgs", "type": "Interface", "tags": [], "label": "UpdateFileArgs", "description": [ "\nArguments to update a file" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.UpdateFileArgs.id", "type": "string", "tags": [], "label": "id", "description": [ "\nFile ID." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.UpdateFileArgs.fileKind", "type": "string", "tags": [], "label": "fileKind", "description": [ "\nFile kind, must correspond to a registered {@link FileKind}." ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-server.UpdateFileArgs.attributes", "type": "Object", "tags": [], "label": "attributes", "description": [ "\nAttributes to update." ], "signature": [ "{ name: string; meta: unknown; alt: string | undefined; }" ], "path": "x-pack/plugins/files/server/file_service/file_action_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "files", "id": "def-server.DeleteArgs", "type": "Type", "tags": [], "label": "DeleteArgs", "description": [ "\nDelete file share arguments." ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-server.GetArgs", "type": "Type", "tags": [], "label": "GetArgs", "description": [ "\nGet file share arguments." ], "signature": [ "IdArg" ], "path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "files", "id": "def-server.FilesSetup", "type": "Interface", "tags": [], "label": "FilesSetup", "description": [ "\nFiles plugin setup contract" ], "path": "x-pack/plugins/files/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FilesSetup.registerFileKind", "type": "Function", "tags": [], "label": "registerFileKind", "description": [ "\nRegister a {@link FileKind} which allows for specifying details about the files\nthat will be uploaded.\n" ], "signature": [ "(fileKind: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileKind", "text": "FileKind" }, ") => void" ], "path": "x-pack/plugins/files/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FilesSetup.registerFileKind.$1", "type": "Object", "tags": [], "label": "fileKind", "description": [ "- the file kind to register" ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileKind", "text": "FileKind" } ], "path": "x-pack/plugins/files/server/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "files", "id": "def-server.FilesStart", "type": "Interface", "tags": [], "label": "FilesStart", "description": [ "\nFiles plugin start contract" ], "path": "x-pack/plugins/files/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-server.FilesStart.fileServiceFactory", "type": "Object", "tags": [], "label": "fileServiceFactory", "description": [ "\nCreate an instance of {@link FileServiceStart}." ], "signature": [ { "pluginId": "files", "scope": "server", "docId": "kibFilesPluginApi", "section": "def-server.FileServiceFactory", "text": "FileServiceFactory" } ], "path": "x-pack/plugins/files/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "files", "id": "def-common.BlobStorageSettings", "type": "Interface", "tags": [], "label": "BlobStorageSettings", "description": [ "\nDefines all the settings for supported blob stores.\n\nKey names map to unique blob store implementations and so must not be changed\nwithout a migration" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.BlobStorageSettings.ES_FIXED_SIZE_INDEX_BLOB_STORE", "type": "Object", "tags": [], "label": "[ES_FIXED_SIZE_INDEX_BLOB_STORE]", "description": [ "\nSingle index that supports up to 50GB of blobs" ], "signature": [ "{ index: string; } | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.File", "type": "Interface", "tags": [], "label": "File", "description": [ "\nA class with set of properties and behaviors of the \"smart\" file object and adds\nbehaviours for interacting with files on top of the pure data." ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, "" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.File.id", "type": "string", "tags": [], "label": "id", "description": [ "\nThe file ID" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.File.data", "type": "Object", "tags": [], "label": "data", "description": [ "\nFile metadata in camelCase form." ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.File.update", "type": "Function", "tags": [], "label": "update", "description": [ "\nUpdate a file object's metadatathat can be updated.\n" ], "signature": [ "(attr: Partial<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.UpdatableFileMetadata", "text": "UpdatableFileMetadata" }, ">) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.File.update.$1", "type": "Object", "tags": [], "label": "attr", "description": [ "- The of attributes to update." ], "signature": [ "Partial<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.UpdatableFileMetadata", "text": "UpdatableFileMetadata" }, ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.uploadContent", "type": "Function", "tags": [], "label": "uploadContent", "description": [ "\nStream file content to storage.\n" ], "signature": [ "(content: ", "Readable", ", abort$?: ", "Observable", " | undefined) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.File", "text": "File" }, ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.File.uploadContent.$1", "type": "Object", "tags": [], "label": "content", "description": [ "- The content to stream to storage." ], "signature": [ "Readable" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "files", "id": "def-common.File.uploadContent.$2", "type": "Object", "tags": [], "label": "abort$", "description": [ "- An observable that can be used to abort the upload at any time." ], "signature": [ "Observable", " | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.downloadContent", "type": "Function", "tags": [], "label": "downloadContent", "description": [ "\nStream file content from storage." ], "signature": [ "() => Promise<", "Readable", ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.delete", "type": "Function", "tags": [ "note" ], "label": "delete", "description": [ "\nDelete a file.\n" ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.share", "type": "Function", "tags": [ "note" ], "label": "share", "description": [ "\nGenerate a secure token that can be used to access a file's content.\n" ], "signature": [ "(opts?: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareOptions", "text": "FileShareOptions" }, " | undefined) => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSONWithToken", "text": "FileShareJSONWithToken" }, ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.File.share.$1", "type": "Object", "tags": [], "label": "opts", "description": [ "- Share file options." ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareOptions", "text": "FileShareOptions" }, " | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.listShares", "type": "Function", "tags": [], "label": "listShares", "description": [ "\nList all current {@link FileShareJSON} objects that have been created for\na file." ], "signature": [ "() => Promise<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, "[]>" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.unshare", "type": "Function", "tags": [], "label": "unshare", "description": [ "\nRemove a {@link FileShareJSON} object therefore ceasing to share a file's\ncontent.\n" ], "signature": [ "(opts: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileUnshareOptions", "text": "FileUnshareOptions" }, ") => Promise" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.File.unshare.$1", "type": "Object", "tags": [], "label": "opts", "description": [ "- Unshare file options" ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileUnshareOptions", "text": "FileUnshareOptions" } ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "files", "id": "def-common.File.toJSON", "type": "Function", "tags": [], "label": "toJSON", "description": [ "\nGet a JSON representation of the file. Convenient for serialisation." ], "signature": [ "() => ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileJSON", "type": "Interface", "tags": [], "label": "FileJSON", "description": [ "\nAttributes of a file that represent a serialised version of the file." ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileJSON", "text": "FileJSON" }, "" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FileJSON.id", "type": "string", "tags": [], "label": "id", "description": [ "\nUnique file ID." ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.created", "type": "string", "tags": [], "label": "created", "description": [ "\nISO string of when this file was created" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.updated", "type": "string", "tags": [], "label": "updated", "description": [ "\nISO string of when the file was updated" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.name", "type": "string", "tags": [ "note" ], "label": "name", "description": [ "\nFile name.\n" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.mimeType", "type": "string", "tags": [], "label": "mimeType", "description": [ "\nMIME type of the file's contents." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.size", "type": "number", "tags": [], "label": "size", "description": [ "\nThe size, in bytes, of the file content." ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.extension", "type": "string", "tags": [ "note" ], "label": "extension", "description": [ "\nThe file extension (dot suffix).\n" ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.meta", "type": "Uncategorized", "tags": [], "label": "meta", "description": [ "\nA consumer defined set of attributes.\n\nConsumers of the file service can add their own tags and identifiers to\na file using the \"meta\" object." ], "signature": [ "Meta | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.alt", "type": "string", "tags": [], "label": "alt", "description": [ "\nUse this text to describe the file contents for display and accessibility." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.fileKind", "type": "string", "tags": [ "note" ], "label": "fileKind", "description": [ "\nA unique kind that governs various aspects of the file. A consumer of the\nfiles service must register a file kind and link their files to a specific\nkind.\n" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileJSON.status", "type": "CompoundType", "tags": [], "label": "status", "description": [ "\nThe current status of the file.\n\nSee {@link FileStatus} for more details." ], "signature": [ "\"AWAITING_UPLOAD\" | \"UPLOADING\" | \"READY\" | \"UPLOAD_ERROR\" | \"DELETED\"" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileKind", "type": "Interface", "tags": [ "note" ], "label": "FileKind", "description": [ "\nA descriptor of meta values associated with a set or \"kind\" of files.\n" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FileKind.id", "type": "string", "tags": [], "label": "id", "description": [ "\nUnique file kind ID" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileKind.maxSizeBytes", "type": "number", "tags": [ "default" ], "label": "maxSizeBytes", "description": [ "\nMaximum size, in bytes, a file of this kind can be.\n" ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileKind.allowedMimeTypes", "type": "Array", "tags": [ "default" ], "label": "allowedMimeTypes", "description": [ "\nThe MIME type of the file content.\n" ], "signature": [ "string[] | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileKind.blobStoreSettings", "type": "Object", "tags": [], "label": "blobStoreSettings", "description": [ "\nBlob store specific settings that enable configuration of storage\ndetails." ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.BlobStorageSettings", "text": "BlobStorageSettings" }, " | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileKind.http", "type": "Object", "tags": [ "note" ], "label": "http", "description": [ "\nSpecify which HTTP routes to create for the file kind.\n\nYou can always create your own HTTP routes for working with files but\nthis interface allows you to expose basic CRUD operations, upload, download\nand sharing of files over a RESTful-like interface.\n" ], "signature": [ "{ create?: HttpEndpointDefinition | undefined; update?: HttpEndpointDefinition | undefined; delete?: HttpEndpointDefinition | undefined; getById?: HttpEndpointDefinition | undefined; list?: HttpEndpointDefinition | undefined; download?: HttpEndpointDefinition | undefined; share?: HttpEndpointDefinition | undefined; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSON", "type": "Interface", "tags": [], "label": "FileShareJSON", "description": [ "\nAttributes of a file that represent a serialised version of the file." ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FileShareJSON.id", "type": "string", "tags": [], "label": "id", "description": [ "\nUnique ID share instance" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSON.created", "type": "string", "tags": [], "label": "created", "description": [ "\nISO timestamp the share was created" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSON.validUntil", "type": "number", "tags": [], "label": "validUntil", "description": [ "\nUnix timestamp (in milliseconds) of when this share expires" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSON.name", "type": "string", "tags": [], "label": "name", "description": [ "\nA user-friendly name for the file share" ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSON.fileId", "type": "string", "tags": [], "label": "fileId", "description": [ "\nThe ID of the file this share is linked to" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileShareOptions", "type": "Interface", "tags": [], "label": "FileShareOptions", "description": [ "\nArguments to pass to share a file" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FileShareOptions.name", "type": "string", "tags": [], "label": "name", "description": [ "\nOptional name for the file share, should be human-friendly." ], "signature": [ "string | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FileShareOptions.validUntil", "type": "number", "tags": [ "note" ], "label": "validUntil", "description": [ "\nUnix timestamp (in milliseconds) when the file share will expire.\n" ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FilesMetrics", "type": "Interface", "tags": [], "label": "FilesMetrics", "description": [ "\nA collection of generally useful metrics about files." ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FilesMetrics.storage", "type": "Object", "tags": [], "label": "storage", "description": [ "\nMetrics about all storage media." ], "signature": [ "{ esFixedSizeIndex: { capacity: number; used: number; available: number; }; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FilesMetrics.countByStatus", "type": "Object", "tags": [], "label": "countByStatus", "description": [ "\nA count of all files grouped by status" ], "signature": [ "{ AWAITING_UPLOAD: number; UPLOADING: number; READY: number; UPLOAD_ERROR: number; DELETED: number; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.FilesMetrics.countByExtension", "type": "Object", "tags": [], "label": "countByExtension", "description": [ "\nA count of all files grouped by extension" ], "signature": [ "{ [x: string]: number; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileUnshareOptions", "type": "Interface", "tags": [], "label": "FileUnshareOptions", "description": [ "\nArguments for unsharing a file" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.FileUnshareOptions.shareId", "type": "string", "tags": [], "label": "shareId", "description": [ "\nSpecify the share instance to remove" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.Pagination", "type": "Interface", "tags": [], "label": "Pagination", "description": [ "\nValues for paginating through results." ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "files", "id": "def-common.Pagination.page", "type": "number", "tags": [], "label": "page", "description": [ "\nPage of results." ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "files", "id": "def-common.Pagination.perPage", "type": "number", "tags": [], "label": "perPage", "description": [ "\nNumber of results per page." ], "signature": [ "number | undefined" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "files", "id": "def-common.BaseFileMetadata", "type": "Type", "tags": [], "label": "BaseFileMetadata", "description": [ "\nFile metadata fields are defined per the ECS specification:\n\nhttps://www.elastic.co/guide/en/ecs/current/ecs-file.html\n\nCustom fields are named according to the custom field convention: \"CustomFieldName\"." ], "signature": [ "{ name?: string | undefined; mime_type?: string | undefined; created?: string | undefined; size?: number | undefined; hash?: { [hashName: string]: string | undefined; md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; extension?: string | undefined; Alt?: string | undefined; Updated?: string | undefined; Status?: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileStatus", "text": "FileStatus" }, " | undefined; ChunkSize?: number | undefined; Compression?: ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileCompression", "text": "FileCompression" }, " | undefined; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.ES_FIXED_SIZE_INDEX_BLOB_STORE", "type": "string", "tags": [], "label": "ES_FIXED_SIZE_INDEX_BLOB_STORE", "description": [ "\nThe name of the fixed size ES-backed blob store" ], "signature": [ "\"esFixedSizeIndex\"" ], "path": "x-pack/plugins/files/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FILE_SO_TYPE", "type": "string", "tags": [], "label": "FILE_SO_TYPE", "description": [ "\nUnique type name of the file saved object" ], "signature": [ "\"file\"" ], "path": "x-pack/plugins/files/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileCompression", "type": "Type", "tags": [], "label": "FileCompression", "description": [ "\nSupported file compression algorithms" ], "signature": [ "\"none\" | \"br\" | \"gzip\" | \"deflate\"" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileMetadata", "type": "Type", "tags": [], "label": "FileMetadata", "description": [ "\nExtra metadata on a file object specific to Kibana implementation." ], "signature": [ "Required> & ", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.BaseFileMetadata", "text": "BaseFileMetadata" }, " & { FileKind: string; Meta?: Meta | undefined; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileSavedObject", "type": "Type", "tags": [], "label": "FileSavedObject", "description": [ "\nAn {@link SavedObject} containing a file object (i.e., metadata only)." ], "signature": [ "SavedObject", "<", { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileMetadata", "text": "FileMetadata" }, ">" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileShare", "type": "Type", "tags": [], "label": "FileShare", "description": [ "\nData stored with a file share object" ], "signature": [ "{ created: string; token: string; name?: string | undefined; valid_until: number; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileShareJSONWithToken", "type": "Type", "tags": [ "note" ], "label": "FileShareJSONWithToken", "description": [ "\nA version of the file share with a token included.\n" ], "signature": [ { "pluginId": "files", "scope": "common", "docId": "kibFilesPluginApi", "section": "def-common.FileShareJSON", "text": "FileShareJSON" }, " & { token: string; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.FileStatus", "type": "Type", "tags": [], "label": "FileStatus", "description": [ "\nStatus of a file.\n\nAWAITING_UPLOAD - A file object has been created but does not have any contents.\nUPLOADING - File contents are being uploaded.\nREADY - File contents have been uploaded and are ready for to be downloaded.\nUPLOAD_ERROR - An attempt was made to upload file contents but failed.\nDELETED - The file contents have been or are being deleted." ], "signature": [ "\"AWAITING_UPLOAD\" | \"UPLOADING\" | \"READY\" | \"UPLOAD_ERROR\" | \"DELETED\"" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.PLUGIN_ID", "type": "string", "tags": [], "label": "PLUGIN_ID", "description": [ "\nThe files plugin ID" ], "signature": [ "\"files\"" ], "path": "x-pack/plugins/files/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.PLUGIN_NAME", "type": "string", "tags": [], "label": "PLUGIN_NAME", "description": [ "\nThe files plugin name" ], "signature": [ "\"files\"" ], "path": "x-pack/plugins/files/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.UpdatableFileMetadata", "type": "Type", "tags": [], "label": "UpdatableFileMetadata", "description": [ "\nThe set of file metadata that can be updated." ], "signature": [ "{ name: string; meta: Meta | undefined; alt: string | undefined; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "files", "id": "def-common.UpdatableFileShareMetadata", "type": "Type", "tags": [], "label": "UpdatableFileShareMetadata", "description": [ "\nSet of attributes that can be updated in a file share." ], "signature": [ "{ name?: string | undefined; }" ], "path": "x-pack/plugins/files/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }