{ "id": "inspector", "client": { "classes": [ { "id": "def-public.InspectorPublicPlugin", "type": "Class", "tags": [], "label": "InspectorPublicPlugin", "description": [], "signature": [ { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorPublicPlugin", "text": "InspectorPublicPlugin" }, " implements ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.Plugin", "text": "Plugin" }, "<", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.Setup", "text": "Setup" }, ", ", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.Start", "text": "Start" }, ", object, object>" ], "children": [ { "tags": [], "id": "def-public.InspectorPublicPlugin.views", "type": "Object", "label": "views", "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 55 }, "signature": [ "InspectorViewRegistry", " | undefined" ] }, { "id": "def-public.InspectorPublicPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "id": "def-public.InspectorPublicPlugin.Unnamed.$1", "type": "Object", "label": "initializerContext", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, "" ], "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 57 } }, { "id": "def-public.InspectorPublicPlugin.setup", "type": "Function", "label": "setup", "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, ") => { registerView: (view: ", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorViewDescription", "text": "InspectorViewDescription" }, ") => void; __LEGACY: { views: ", "InspectorViewRegistry", "; }; }" ], "description": [], "children": [ { "id": "def-public.InspectorPublicPlugin.setup.$1", "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, "" ], "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 59 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 59 } }, { "id": "def-public.InspectorPublicPlugin.start", "type": "Function", "label": "start", "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ") => { isAvailable: (adapters?: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined) => boolean; open: (adapters: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", options?: ", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorOptions", "text": "InspectorOptions" }, " | undefined) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayRef", "text": "OverlayRef" } ], "description": [], "children": [ { "id": "def-public.InspectorPublicPlugin.start.$1", "type": "Object", "label": "core", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" } ], "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 73 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 73 } }, { "id": "def-public.InspectorPublicPlugin.stop", "type": "Function", "label": "stop", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 114 } } ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-public.RequestAdapter", "type": "Class", "tags": [ "extends" ], "label": "RequestAdapter", "description": [ "\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind." ], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " extends ", "EventEmitter" ], "children": [ { "id": "def-public.RequestAdapter.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 24 } }, { "id": "def-public.RequestAdapter.start", "type": "Function", "label": "start", "signature": [ "(name: string, params?: ", "RequestParams", ") => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [ "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" ], "children": [ { "id": "def-public.RequestAdapter.start.$1", "type": "string", "label": "name", "isRequired": true, "signature": [ "string" ], "description": [ "The name of this request as it should be shown in the UI." ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } }, { "id": "def-public.RequestAdapter.start.$2", "type": "Object", "label": "params", "isRequired": true, "signature": [ "RequestParams" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } } ], "tags": [ "return" ], "returnComment": [ "An instance to add information to the request and finish it." ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } }, { "id": "def-public.RequestAdapter.reset", "type": "Function", "label": "reset", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 52 } }, { "id": "def-public.RequestAdapter.resetRequest", "type": "Function", "label": "resetRequest", "signature": [ "(id: string) => void" ], "description": [], "children": [ { "id": "def-public.RequestAdapter.resetRequest.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 } }, { "id": "def-public.RequestAdapter.getRequests", "type": "Function", "label": "getRequests", "signature": [ "() => ", "Request", "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 62 } } ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-public.RequestResponder", "type": "Class", "tags": [], "label": "RequestResponder", "description": [ "\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}." ], "children": [ { "id": "def-public.RequestResponder.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "id": "def-public.RequestResponder.Unnamed.$1", "type": "Object", "label": "request", "isRequired": true, "signature": [ "Request" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } }, { "id": "def-public.RequestResponder.Unnamed.$2", "type": "Function", "label": "onChange", "isRequired": true, "signature": [ "() => void" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } }, { "id": "def-public.RequestResponder.json", "type": "Function", "label": "json", "signature": [ "(reqJson: object) => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [], "children": [ { "id": "def-public.RequestResponder.json.$1", "type": "Uncategorized", "label": "reqJson", "isRequired": true, "signature": [ "object" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 } }, { "id": "def-public.RequestResponder.stats", "type": "Function", "label": "stats", "signature": [ "(stats: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" }, ") => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [], "children": [ { "id": "def-public.RequestResponder.stats.$1", "type": "Object", "label": "stats", "isRequired": true, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" } ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 } }, { "id": "def-public.RequestResponder.finish", "type": "Function", "label": "finish", "signature": [ "(status: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatus", "text": "RequestStatus" }, ", response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-public.RequestResponder.finish.$1", "type": "Enum", "label": "status", "isRequired": true, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatus", "text": "RequestStatus" } ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } }, { "id": "def-public.RequestResponder.finish.$2", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } }, { "id": "def-public.RequestResponder.ok", "type": "Function", "label": "ok", "signature": [ "(response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-public.RequestResponder.ok.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 } }, { "id": "def-public.RequestResponder.error", "type": "Function", "label": "error", "signature": [ "(response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-public.RequestResponder.error.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 } } ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 16 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { "id": "def-public.Adapters", "type": "Interface", "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], "tags": [], "children": [ { "tags": [], "id": "def-public.Adapters.requests", "type": "Object", "label": "requests", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 15 }, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined" ] }, { "id": "def-public.Adapters.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-public.InspectorOptions", "type": "Interface", "label": "InspectorOptions", "description": [ "\nOptions that can be specified when opening the inspector." ], "tags": [ "property" ], "children": [ { "tags": [], "id": "def-public.InspectorOptions.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 60 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.InspectorOptions.options", "type": "Unknown", "label": "options", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 61 }, "signature": [ "unknown" ] } ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 59 }, "initialIsOpen": false }, { "id": "def-public.InspectorViewDescription", "type": "Interface", "label": "InspectorViewDescription", "description": [ "\nAn object describing an inspector view." ], "tags": [ "typedef" ], "children": [ { "tags": [], "id": "def-public.InspectorViewDescription.component", "type": "CompoundType", "label": "component", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 46 }, "signature": [ "React.ComponentType<", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorViewProps", "text": "InspectorViewProps" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ">>" ] }, { "tags": [], "id": "def-public.InspectorViewDescription.help", "type": "string", "label": "help", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 47 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.InspectorViewDescription.order", "type": "number", "label": "order", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 48 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-public.InspectorViewDescription.shouldShow", "type": "Function", "label": "shouldShow", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 49 }, "signature": [ "((adapters: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ") => boolean) | undefined" ] }, { "tags": [], "id": "def-public.InspectorViewDescription.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 50 } } ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 45 }, "initialIsOpen": false }, { "id": "def-public.InspectorViewProps", "type": "Interface", "label": "InspectorViewProps", "signature": [ { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorViewProps", "text": "InspectorViewProps" }, "" ], "description": [ "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." ], "tags": [], "children": [ { "tags": [], "id": "def-public.InspectorViewProps.adapters", "type": "Uncategorized", "label": "adapters", "description": [ "\nAdapters used to open the inspector." ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 20 }, "signature": [ "TAdapters" ] }, { "tags": [], "id": "def-public.InspectorViewProps.title", "type": "string", "label": "title", "description": [ "\nThe title that the inspector is currently using e.g. a visualization name." ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-public.InspectorViewProps.options", "type": "Unknown", "label": "options", "description": [ "\nA set of specific options for each view." ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 28 }, "signature": [ "unknown" ] } ], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 16 }, "initialIsOpen": false }, { "id": "def-public.RequestStatistic", "type": "Interface", "label": "RequestStatistic", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.RequestStatistic.label", "type": "string", "label": "label", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 49 } }, { "tags": [], "id": "def-public.RequestStatistic.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 50 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.RequestStatistic.value", "type": "Any", "label": "value", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 51 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 48 }, "initialIsOpen": false }, { "id": "def-public.RequestStatistics", "type": "Interface", "label": "RequestStatistics", "description": [], "tags": [], "children": [ { "id": "def-public.RequestStatistics.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 45 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 44 }, "initialIsOpen": false } ], "enums": [ { "id": "def-public.RequestStatus", "type": "Enum", "label": "RequestStatus", "tags": [], "description": [ "\nThe status a request can have." ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 12 }, "initialIsOpen": false } ], "misc": [ { "id": "def-public.InspectorSession", "type": "Type", "label": "InspectorSession", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", "lineNumber": 64 }, "signature": [ "OverlayRef" ], "initialIsOpen": false } ], "objects": [], "setup": { "id": "def-public.Setup", "type": "Interface", "label": "Setup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Setup.registerView", "type": "Function", "label": "registerView", "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 21 }, "signature": [ "(view: ", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorViewDescription", "text": "InspectorViewDescription" }, ") => void" ] }, { "tags": [], "id": "def-public.Setup.__LEGACY", "type": "Object", "label": "__LEGACY", "description": [], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 23 }, "signature": [ "{ views: ", "InspectorViewRegistry", "; }" ] } ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 20 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-public.Start", "type": "Interface", "label": "Start", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Start.isAvailable", "type": "Function", "label": "isAvailable", "description": [ "\nChecks if a inspector panel could be shown based on the passed adapters.\n" ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 37 }, "signature": [ "(adapters?: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined) => boolean" ] }, { "tags": [ "return", "throws" ], "id": "def-public.Start.open", "type": "Function", "label": "open", "description": [ "\nOpens the inspector panel for the given adapters and close any previously opened\ninspector panel. The previously panel will be closed also if no new panel will be\nopened (e.g. because of the passed adapters no view is available). You can use\n{@link InspectorSession#close} on the return value to close that opened panel again.\n" ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 51 }, "signature": [ "(adapters: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", options?: ", { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.InspectorOptions", "text": "InspectorOptions" }, " | undefined) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayRef", "text": "OverlayRef" } ] } ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", "lineNumber": 28 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [ { "id": "def-common.RequestAdapter", "type": "Class", "tags": [ "extends" ], "label": "RequestAdapter", "description": [ "\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind." ], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " extends ", "EventEmitter" ], "children": [ { "id": "def-common.RequestAdapter.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 24 } }, { "id": "def-common.RequestAdapter.start", "type": "Function", "label": "start", "signature": [ "(name: string, params?: ", "RequestParams", ") => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [ "\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n" ], "children": [ { "id": "def-common.RequestAdapter.start.$1", "type": "string", "label": "name", "isRequired": true, "signature": [ "string" ], "description": [ "The name of this request as it should be shown in the UI." ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } }, { "id": "def-common.RequestAdapter.start.$2", "type": "Object", "label": "params", "isRequired": true, "signature": [ "RequestParams" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } } ], "tags": [ "return" ], "returnComment": [ "An instance to add information to the request and finish it." ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 39 } }, { "id": "def-common.RequestAdapter.reset", "type": "Function", "label": "reset", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 52 } }, { "id": "def-common.RequestAdapter.resetRequest", "type": "Function", "label": "resetRequest", "signature": [ "(id: string) => void" ], "description": [], "children": [ { "id": "def-common.RequestAdapter.resetRequest.$1", "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 57 } }, { "id": "def-common.RequestAdapter.getRequests", "type": "Function", "label": "getRequests", "signature": [ "() => ", "Request", "[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 62 } } ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_adapter.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-common.RequestResponder", "type": "Class", "tags": [], "label": "RequestResponder", "description": [ "\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}." ], "children": [ { "id": "def-common.RequestResponder.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "id": "def-common.RequestResponder.Unnamed.$1", "type": "Object", "label": "request", "isRequired": true, "signature": [ "Request" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } }, { "id": "def-common.RequestResponder.Unnamed.$2", "type": "Function", "label": "onChange", "isRequired": true, "signature": [ "() => void" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 20 } }, { "id": "def-common.RequestResponder.json", "type": "Function", "label": "json", "signature": [ "(reqJson: object) => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [], "children": [ { "id": "def-common.RequestResponder.json.$1", "type": "Uncategorized", "label": "reqJson", "isRequired": true, "signature": [ "object" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 25 } }, { "id": "def-common.RequestResponder.stats", "type": "Function", "label": "stats", "signature": [ "(stats: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" }, ") => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestResponder", "text": "RequestResponder" } ], "description": [], "children": [ { "id": "def-common.RequestResponder.stats.$1", "type": "Object", "label": "stats", "isRequired": true, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" } ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 31 } }, { "id": "def-common.RequestResponder.finish", "type": "Function", "label": "finish", "signature": [ "(status: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatus", "text": "RequestStatus" }, ", response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-common.RequestResponder.finish.$1", "type": "Enum", "label": "status", "isRequired": true, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatus", "text": "RequestStatus" } ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } }, { "id": "def-common.RequestResponder.finish.$2", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 53 } }, { "id": "def-common.RequestResponder.ok", "type": "Function", "label": "ok", "signature": [ "(response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-common.RequestResponder.ok.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 60 } }, { "id": "def-common.RequestResponder.error", "type": "Function", "label": "error", "signature": [ "(response: ", "Response", ") => void" ], "description": [], "children": [ { "id": "def-common.RequestResponder.error.$1", "type": "Object", "label": "response", "isRequired": true, "signature": [ "Response" ], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 64 } } ], "source": { "path": "src/plugins/inspector/common/adapters/request/request_responder.ts", "lineNumber": 16 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { "id": "def-common.Adapters", "type": "Interface", "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], "tags": [], "children": [ { "tags": [], "id": "def-common.Adapters.requests", "type": "Object", "label": "requests", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 15 }, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined" ] }, { "id": "def-common.Adapters.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-common.RequestStatistic", "type": "Interface", "label": "RequestStatistic", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.RequestStatistic.label", "type": "string", "label": "label", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 49 } }, { "tags": [], "id": "def-common.RequestStatistic.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 50 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-common.RequestStatistic.value", "type": "Any", "label": "value", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 51 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 48 }, "initialIsOpen": false }, { "id": "def-common.RequestStatistics", "type": "Interface", "label": "RequestStatistics", "description": [], "tags": [], "children": [ { "id": "def-common.RequestStatistics.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 45 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 44 }, "initialIsOpen": false } ], "enums": [ { "id": "def-common.RequestStatus", "type": "Enum", "label": "RequestStatus", "tags": [], "description": [ "\nThe status a request can have." ], "source": { "path": "src/plugins/inspector/common/adapters/request/types.ts", "lineNumber": 12 }, "initialIsOpen": false } ], "misc": [], "objects": [] } }