{ "id": "esUiShared", "client": { "classes": [ { "id": "def-public.CronEditor", "type": "Class", "tags": [], "label": "CronEditor", "description": [], "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.CronEditor", "text": "CronEditor" }, " extends React.Component" ], "children": [ { "id": "def-public.CronEditor.getDerivedStateFromProps", "type": "Function", "label": "getDerivedStateFromProps", "signature": [ "typeof ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.CronEditor", "text": "CronEditor" }, ".getDerivedStateFromProps" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 65, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65" } }, { "id": "def-public.CronEditor.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 70, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70" } }, { "id": "def-public.CronEditor.onChangeFrequency", "type": "Function", "children": [ { "type": "CompoundType", "label": "frequency", "isRequired": true, "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.Frequency", "text": "Frequency" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80" } } ], "signature": [ "(frequency: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.Frequency", "text": "Frequency" }, ") => void" ], "description": [], "label": "onChangeFrequency", "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 80, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80" }, "tags": [], "returnComment": [] }, { "id": "def-public.CronEditor.onChangeFields", "type": "Function", "children": [ { "type": "Object", "label": "fields", "isRequired": true, "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.FieldToValueMap", "text": "FieldToValueMap" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104" } } ], "signature": [ "(fields: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.FieldToValueMap", "text": "FieldToValueMap" }, ") => void" ], "description": [], "label": "onChangeFields", "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 104, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104" }, "tags": [], "returnComment": [] }, { "id": "def-public.CronEditor.renderForm", "type": "Function", "label": "renderForm", "signature": [ "() => JSX.Element | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 140, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L140" } }, { "id": "def-public.CronEditor.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 215, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L215" } } ], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx", "lineNumber": 64, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L64" }, "initialIsOpen": false } ], "functions": [ { "tags": [], "id": "def-public.JsonEditor", "type": "Function", "label": "JsonEditor", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx", "lineNumber": 102, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx#L102" }, "signature": [ "typeof JsonEditorComp" ], "initialIsOpen": false }, { "id": "def-public.SectionLoading", "type": "Function", "children": [ { "type": "CompoundType", "label": "{ inline, children, ...rest }", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26" } } ], "signature": [ "({ inline, children, ...rest }: React.PropsWithChildren) => JSX.Element" ], "description": [], "label": "SectionLoading", "source": { "path": "src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx", "lineNumber": 26, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.sendRequest", "type": "Function", "children": [ { "type": "Object", "label": "httpClient", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L29" } }, { "type": "Object", "label": "{ path, method, body, query, asSystemRequest }", "isRequired": true, "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.SendRequestConfig", "text": "SendRequestConfig" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L30" } } ], "signature": [ "(httpClient: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" }, ", { path, method, body, query, asSystemRequest }: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.SendRequestConfig", "text": "SendRequestConfig" }, ") => Promise<", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.SendRequestResponse", "text": "SendRequestResponse" }, ">" ], "description": [], "label": "sendRequest", "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L28" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.useRequest", "type": "Function", "children": [ { "type": "Object", "label": "httpClient", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 29, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L29" } }, { "type": "Object", "label": "{ path, method, query, body, pollIntervalMs, initialData, deserializer }", "isRequired": true, "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.UseRequestConfig", "text": "UseRequestConfig" } ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 30, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L30" } } ], "signature": [ "(httpClient: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" }, ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.UseRequestConfig", "text": "UseRequestConfig" }, ") => ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.UseRequestResponse", "text": "UseRequestResponse" }, "" ], "description": [], "label": "useRequest", "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 28, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L28" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.AuthorizationProvider", "type": "Function", "children": [ { "type": "Object", "label": "{ privilegesEndpoint, httpClient, children }", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49" } } ], "signature": [ "({ privilegesEndpoint, httpClient, children }: Props) => JSX.Element" ], "description": [], "label": "AuthorizationProvider", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 49, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.NotAuthorizedSection", "type": "Function", "children": [ { "type": "Object", "label": "{ title, message }", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17" } } ], "signature": [ "({ title, message }: Props) => JSX.Element" ], "description": [], "label": "NotAuthorizedSection", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.WithPrivileges", "type": "Function", "children": [ { "type": "Object", "label": "{ privileges: requiredPrivileges, children }", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32" } } ], "signature": [ "({ privileges: requiredPrivileges, children }: Props) => JSX.Element" ], "description": [], "label": "WithPrivileges", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", "lineNumber": 32, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.SectionError", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n title,\n error,\n actions,\n ...rest\n}", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24" } } ], "signature": [ "({ title, error, actions, ...rest }: React.PropsWithChildren) => JSX.Element" ], "description": [], "label": "SectionError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.useAuthorizationContext", "type": "Function", "children": [], "signature": [ "() => Authorization" ], "description": [], "label": "useAuthorizationContext", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 35, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L35" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.extractQueryParams", "type": "Function", "label": "extractQueryParams", "signature": [ "(queryString: string) => ", "ParsedQuery", "" ], "description": [], "children": [ { "type": "string", "label": "queryString", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11" }, "initialIsOpen": false }, { "id": "def-public.attemptToURIDecode", "type": "Function", "children": [ { "type": "string", "label": "value", "isRequired": false, "signature": [ "string | undefined" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15" } } ], "signature": [ "(value?: string | undefined) => string | undefined" ], "description": [], "label": "attemptToURIDecode", "source": { "path": "src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15" }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.JsonEditorState", "type": "Interface", "label": "JsonEditorState", "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.JsonEditorState", "text": "JsonEditorState" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.JsonEditorState.data", "type": "Object", "label": "data", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L15" }, "signature": [ "{ raw: string; format(): T; }" ] }, { "id": "def-public.JsonEditorState.validate", "type": "Function", "label": "validate", "signature": [ "() => boolean" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L19" } }, { "tags": [], "id": "def-public.JsonEditorState.isValid", "type": "CompoundType", "label": "isValid", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L20" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L14" }, "initialIsOpen": false }, { "id": "def-public.SendRequestConfig", "type": "Interface", "label": "SendRequestConfig", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SendRequestConfig.path", "type": "string", "label": "path", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L12" } }, { "tags": [], "id": "def-public.SendRequestConfig.method", "type": "CompoundType", "label": "method", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L13" }, "signature": [ "\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" ] }, { "tags": [], "id": "def-public.SendRequestConfig.query", "type": "Object", "label": "query", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L14" }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchQuery", "text": "HttpFetchQuery" }, " | undefined" ] }, { "tags": [], "id": "def-public.SendRequestConfig.body", "type": "Any", "label": "body", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L15" }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.SendRequestConfig.asSystemRequest", "type": "CompoundType", "label": "asSystemRequest", "description": [ "\nIf set, flags this as a \"system request\" to indicate that this is not a user-initiated request. For more information, see\nHttpFetchOptions#asSystemRequest." ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L20" }, "signature": [ "boolean | undefined" ] } ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 11, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L11" }, "initialIsOpen": false }, { "id": "def-public.SendRequestResponse", "type": "Interface", "label": "SendRequestResponse", "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.SendRequestResponse", "text": "SendRequestResponse" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SendRequestResponse.data", "type": "CompoundType", "label": "data", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L24" }, "signature": [ "D | null" ] }, { "tags": [], "id": "def-public.SendRequestResponse.error", "type": "CompoundType", "label": "error", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L25" }, "signature": [ "E | null" ] } ], "source": { "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/send_request.ts#L23" }, "initialIsOpen": false }, { "id": "def-public.UseRequestConfig", "type": "Interface", "label": "UseRequestConfig", "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.UseRequestConfig", "text": "UseRequestConfig" }, " extends ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.SendRequestConfig", "text": "SendRequestConfig" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.UseRequestConfig.pollIntervalMs", "type": "number", "label": "pollIntervalMs", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L15" }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-public.UseRequestConfig.initialData", "type": "Any", "label": "initialData", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 16, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L16" }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.UseRequestConfig.deserializer", "type": "Function", "label": "deserializer", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L17" }, "signature": [ "((data: any) => any) | undefined" ] } ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L14" }, "initialIsOpen": false }, { "id": "def-public.UseRequestResponse", "type": "Interface", "label": "UseRequestResponse", "signature": [ { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.UseRequestResponse", "text": "UseRequestResponse" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.UseRequestResponse.isInitialRequest", "type": "boolean", "label": "isInitialRequest", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L21" } }, { "tags": [], "id": "def-public.UseRequestResponse.isLoading", "type": "boolean", "label": "isLoading", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 22, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L22" } }, { "tags": [], "id": "def-public.UseRequestResponse.error", "type": "CompoundType", "label": "error", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L23" }, "signature": [ "E | null" ] }, { "tags": [], "id": "def-public.UseRequestResponse.data", "type": "CompoundType", "label": "data", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 24, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L24" }, "signature": [ "D | null | undefined" ] }, { "tags": [], "id": "def-public.UseRequestResponse.resendRequest", "type": "Function", "label": "resendRequest", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 25, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L25" }, "signature": [ "() => void" ] } ], "source": { "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/request/use_request.ts#L20" }, "initialIsOpen": false }, { "id": "def-public.Privileges", "type": "Interface", "label": "Privileges", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Privileges.hasAllPrivileges", "type": "boolean", "label": "hasAllPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14" } }, { "tags": [], "id": "def-public.Privileges.missingPrivileges", "type": "Object", "label": "missingPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15" }, "signature": [ { "pluginId": "esUiShared", "scope": "common", "docId": "kibEsUiSharedPluginApi", "section": "def-common.MissingPrivileges", "text": "MissingPrivileges" } ] } ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13" }, "initialIsOpen": false }, { "id": "def-public.MissingPrivileges", "type": "Interface", "label": "MissingPrivileges", "description": [], "tags": [], "children": [ { "id": "def-public.MissingPrivileges.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10" }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9" }, "initialIsOpen": false }, { "id": "def-public.Error", "type": "Interface", "label": "Error", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Error.error", "type": "string", "label": "error", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L13" } }, { "tags": [], "id": "def-public.Error.cause", "type": "Array", "label": "cause", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L14" }, "signature": [ "string[] | undefined" ] }, { "tags": [], "id": "def-public.Error.message", "type": "string", "label": "message", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L15" }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", "lineNumber": 12, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L12" }, "initialIsOpen": false } ], "enums": [], "misc": [ { "id": "def-public.OnJsonEditorUpdateHandler", "type": "Type", "label": "OnJsonEditorUpdateHandler", "tags": [], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L23" }, "signature": [ "(arg: ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.JsonEditorState", "text": "JsonEditorState" }, ") => void" ], "initialIsOpen": false }, { "id": "def-public.Frequency", "type": "Type", "label": "Frequency", "tags": [], "description": [], "source": { "path": "src/plugins/es_ui_shared/public/components/cron_editor/types.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/components/cron_editor/types.ts#L9" }, "signature": [ "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" ], "initialIsOpen": false } ], "objects": [ { "id": "def-public.indices", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.indices.INDEX_ILLEGAL_CHARACTERS_VISIBLE", "type": "Array", "label": "INDEX_ILLEGAL_CHARACTERS_VISIBLE", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 18, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/indices/index.ts#L18" }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.indices.indexNameBeginsWithPeriod", "type": "Function", "label": "indexNameBeginsWithPeriod", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 19, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/indices/index.ts#L19" }, "signature": [ "typeof ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.indexNameBeginsWithPeriod", "text": "indexNameBeginsWithPeriod" } ] }, { "tags": [], "id": "def-public.indices.findIllegalCharactersInIndexName", "type": "Function", "label": "findIllegalCharactersInIndexName", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 20, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/indices/index.ts#L20" }, "signature": [ "typeof ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.findIllegalCharactersInIndexName", "text": "findIllegalCharactersInIndexName" } ] }, { "tags": [], "id": "def-public.indices.indexNameContainsSpaces", "type": "Function", "label": "indexNameContainsSpaces", "description": [], "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/indices/index.ts#L21" }, "signature": [ "typeof ", { "pluginId": "esUiShared", "scope": "public", "docId": "kibEsUiSharedPluginApi", "section": "def-public.indexNameContainsSpaces", "text": "indexNameContainsSpaces" } ] } ], "description": [], "label": "indices", "source": { "path": "src/plugins/es_ui_shared/public/indices/index.ts", "lineNumber": 17, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/public/indices/index.ts#L17" }, "initialIsOpen": false }, { "tags": [], "id": "def-public.AuthorizationContext", "type": "Object", "label": "AuthorizationContext", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", "lineNumber": 33, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L33" }, "signature": [ "React.Context" ], "initialIsOpen": false } ] }, "server": { "classes": [], "functions": [ { "id": "def-server.isEsError", "type": "Function", "label": "isEsError", "signature": [ "(err: RequestError) => boolean" ], "description": [], "children": [ { "type": "Object", "label": "err", "isRequired": true, "signature": [ "RequestError" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21" } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", "lineNumber": 21, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21" }, "initialIsOpen": false }, { "id": "def-server.handleEsError", "type": "Function", "children": [ { "type": "Object", "label": "{\n error,\n response,\n handleCustomError,\n}", "isRequired": true, "signature": [ "EsErrorHandlerParams" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" } } ], "signature": [ "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, "" ], "description": [], "label": "handleEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", "lineNumber": 23, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-server.parseEsError", "type": "Function", "children": [ { "type": "string", "label": "err", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27" } } ], "signature": [ "(err: string) => ParsedError" ], "description": [], "label": "parseEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts", "lineNumber": 27, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27" }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [ { "id": "def-common.Privileges", "type": "Interface", "label": "Privileges", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.Privileges.hasAllPrivileges", "type": "boolean", "label": "hasAllPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 14, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14" } }, { "tags": [], "id": "def-common.Privileges.missingPrivileges", "type": "Object", "label": "missingPrivileges", "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 15, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15" }, "signature": [ { "pluginId": "esUiShared", "scope": "common", "docId": "kibEsUiSharedPluginApi", "section": "def-common.MissingPrivileges", "text": "MissingPrivileges" } ] } ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 13, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13" }, "initialIsOpen": false }, { "id": "def-common.MissingPrivileges", "type": "Interface", "label": "MissingPrivileges", "description": [], "tags": [], "children": [ { "id": "def-common.MissingPrivileges.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 10, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10" }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", "lineNumber": 9, "link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9" }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] } }