github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_custom_integrations.devdocs.json

404 lines
No EOL
14 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/custom-integrations",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.ConnectedCustomIntegrationsButton",
"type": "Function",
"tags": [],
"label": "ConnectedCustomIntegrationsButton",
"description": [],
"signature": [
"({ isDisabled, onClick, testSubj, }: ConnectedCustomIntegrationsButtonProps) => React.JSX.Element | null"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/components/custom_integrations_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.ConnectedCustomIntegrationsButton.$1",
"type": "Object",
"tags": [],
"label": "{\n isDisabled,\n onClick,\n testSubj = 'customIntegrationsPackageConnectedButton',\n}",
"description": [],
"signature": [
"ConnectedCustomIntegrationsButtonProps"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/components/custom_integrations_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.ConnectedCustomIntegrationsForm",
"type": "Function",
"tags": [],
"label": "ConnectedCustomIntegrationsForm",
"description": [],
"signature": [
"({ testSubjects }: Props) => React.JSX.Element | null"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/components/custom_integrations_form.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.ConnectedCustomIntegrationsForm.$1",
"type": "Object",
"tags": [],
"label": "{ testSubjects }",
"description": [],
"signature": [
"Props"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/components/custom_integrations_form.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.CustomIntegrationsProvider",
"type": "Function",
"tags": [],
"label": "CustomIntegrationsProvider",
"description": [],
"signature": [
"React.FunctionComponent<React.PropsWithChildren<ProviderProps>>"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.CustomIntegrationsProvider.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.CustomIntegrationsProvider.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.useConsumerCustomIntegrations",
"type": "Function",
"tags": [],
"label": "useConsumerCustomIntegrations",
"description": [],
"signature": [
"() => { mode: ",
"Mode",
"; dispatchableEvents: { saveCreateFields: (() => void) | undefined; updateCreateFields: ((fields: Partial<{ integrationName: string; datasets: { name: string; type: \"metrics\" | \"logs\"; }[]; }>) => void) | undefined; }; }"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/hooks/use_consumer_custom_integrations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.useCustomIntegrations",
"type": "Function",
"tags": [],
"label": "useCustomIntegrations",
"description": [],
"signature": [
"() => { customIntegrationsState: ",
"State",
"<",
"WithSelectedMode",
", ",
"CreateCustomIntegrationNotificationEvent",
", any, ",
"CustomIntegrationsTypestate",
", ",
"ResolveTypegenMeta",
"<",
"TypegenDisabled",
", ",
"CreateCustomIntegrationNotificationEvent",
", ",
"BaseActionObject",
", ",
"ServiceMap",
">>; customIntegrationsPageSend: (event: ",
"SingleOrArray",
"<",
"Event",
"<",
"CreateCustomIntegrationNotificationEvent",
">> | ",
"SCXML",
".Event<",
"CreateCustomIntegrationNotificationEvent",
">, payload?: ",
"EventData",
" | undefined) => ",
"State",
"<",
"WithSelectedMode",
", ",
"CreateCustomIntegrationNotificationEvent",
", any, ",
"CustomIntegrationsTypestate",
", ",
"ResolveTypegenMeta",
"<",
"TypegenDisabled",
", ",
"CreateCustomIntegrationNotificationEvent",
", ",
"BaseActionObject",
", ",
"ServiceMap",
">>; customIntegrationsStateService: ",
"Interpreter",
"<",
"WithSelectedMode",
", any, ",
"CreateCustomIntegrationNotificationEvent",
", ",
"CustomIntegrationsTypestate",
", ",
"ResolveTypegenMeta",
"<",
"TypegenDisabled",
", ",
"CreateCustomIntegrationNotificationEvent",
", ",
"BaseActionObject",
", ",
"ServiceMap",
">>; }"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/hooks/use_custom_integrations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks",
"type": "Interface",
"tags": [],
"label": "Callbacks",
"description": [],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCreation",
"type": "Function",
"tags": [],
"label": "onIntegrationCreation",
"description": [],
"signature": [
"((integrationOptions: { integrationName: string; datasets: { name: string; type: \"metrics\" | \"logs\"; }[]; }) => void) | undefined"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCreation.$1",
"type": "Object",
"tags": [],
"label": "integrationOptions",
"description": [],
"signature": [
"{ integrationName: string; datasets: { name: string; type: \"metrics\" | \"logs\"; }[]; }"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCleanup",
"type": "Function",
"tags": [],
"label": "onIntegrationCleanup",
"description": [],
"signature": [
"((integrationName: string) => void) | undefined"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCleanup.$1",
"type": "string",
"tags": [],
"label": "integrationName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCleanupFailed",
"type": "Function",
"tags": [],
"label": "onIntegrationCleanupFailed",
"description": [],
"signature": [
"((error: ",
"IntegrationError",
") => void) | undefined"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.Callbacks.onIntegrationCleanupFailed.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"IntegrationError"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.CustomIntegrationOptions",
"type": "Type",
"tags": [],
"label": "CustomIntegrationOptions",
"description": [],
"signature": [
"{ integrationName: string; datasets: { name: string; type: \"metrics\" | \"logs\"; }[]; }"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.DispatchableEvents",
"type": "Type",
"tags": [],
"label": "DispatchableEvents",
"description": [],
"signature": [
"{ saveCreateFields: (() => void) | undefined; updateCreateFields: ((fields: Partial<{ integrationName: string; datasets: { name: string; type: \"metrics\" | \"logs\"; }[]; }>) => void) | undefined; }"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/hooks/use_consumer_custom_integrations.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/custom-integrations",
"id": "def-public.InitialState",
"type": "Type",
"tags": [],
"label": "InitialState",
"description": [],
"signature": [
"{ context?: Partial<",
"CreateInitialState",
"> | undefined; } & ",
"WithSelectedMode"
],
"path": "x-pack/solutions/observability/packages/kbn-custom-integrations/src/state_machines/custom_integrations/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink