kibana/api_docs/custom_integrations.json

{
  "id": "customIntegrations",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-public.filterCustomIntegrations",
        "type": "Function",
        "tags": [],
        "label": "filterCustomIntegrations",
        "description": [
          "\nFilter a set of integrations by eprPackageName, and/or shipper."
        ],
        "signature": [
          "(integrations: ",
          {
            "pluginId": "customIntegrations",
            "scope": "common",
            "docId": "kibCustomIntegrationsPluginApi",
            "section": "def-common.CustomIntegration",
            "text": "CustomIntegration"
          },
          "[], { eprPackageName, shipper }?: FindParams) => ",
          {
            "pluginId": "customIntegrations",
            "scope": "common",
            "docId": "kibCustomIntegrationsPluginApi",
            "section": "def-common.CustomIntegration",
            "text": "CustomIntegration"
          },
          "[]"
        ],
        "path": "src/plugins/custom_integrations/public/services/find.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-public.filterCustomIntegrations.$1",
            "type": "Array",
            "tags": [],
            "label": "integrations",
            "description": [],
            "signature": [
              {
                "pluginId": "customIntegrations",
                "scope": "common",
                "docId": "kibCustomIntegrationsPluginApi",
                "section": "def-common.CustomIntegration",
                "text": "CustomIntegration"
              },
              "[]"
            ],
            "path": "src/plugins/custom_integrations/public/services/find.ts",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-public.filterCustomIntegrations.$2",
            "type": "Object",
            "tags": [],
            "label": "{ eprPackageName, shipper }",
            "description": [],
            "signature": [
              "FindParams"
            ],
            "path": "src/plugins/custom_integrations/public/services/find.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-public.LazyReplacementCard",
        "type": "Function",
        "tags": [],
        "label": "LazyReplacementCard",
        "description": [],
        "signature": [
          "React.ExoticComponent<",
          "Props",
          "> & { readonly _result: ({ eprPackageName }: ",
          "Props",
          ") => JSX.Element | null; }"
        ],
        "path": "src/plugins/custom_integrations/public/components/index.tsx",
        "deprecated": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-public.LazyReplacementCard.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/index.d.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-public.withSuspense",
        "type": "Function",
        "tags": [],
        "label": "withSuspense",
        "description": [
          "\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors."
        ],
        "signature": [
          "<P extends {}, R = {}>(Component: React.ComponentType<P>, fallback?: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) => React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>"
        ],
        "path": "src/plugins/custom_integrations/public/components/index.tsx",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-public.withSuspense.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "Component",
            "description": [
              "A component deferred by `React.lazy`"
            ],
            "signature": [
              "React.ComponentType<P>"
            ],
            "path": "src/plugins/custom_integrations/public/components/index.tsx",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-public.withSuspense.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "fallback",
            "description": [
              "A fallback component to render while things load; default is `EuiLoadingSpinner`"
            ],
            "signature": [
              "React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
            ],
            "path": "src/plugins/custom_integrations/public/components/index.tsx",
            "deprecated": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "customIntegrations",
      "id": "def-public.CustomIntegrationsSetup",
      "type": "Interface",
      "tags": [],
      "label": "CustomIntegrationsSetup",
      "description": [],
      "path": "src/plugins/custom_integrations/public/types.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "customIntegrations",
          "id": "def-public.CustomIntegrationsSetup.getAppendCustomIntegrations",
          "type": "Function",
          "tags": [],
          "label": "getAppendCustomIntegrations",
          "description": [],
          "signature": [
            "() => Promise<",
            {
              "pluginId": "customIntegrations",
              "scope": "common",
              "docId": "kibCustomIntegrationsPluginApi",
              "section": "def-common.CustomIntegration",
              "text": "CustomIntegration"
            },
            "[]>"
          ],
          "path": "src/plugins/custom_integrations/public/types.ts",
          "deprecated": false,
          "children": [],
          "returnComment": []
        },
        {
          "parentPluginId": "customIntegrations",
          "id": "def-public.CustomIntegrationsSetup.getReplacementCustomIntegrations",
          "type": "Function",
          "tags": [],
          "label": "getReplacementCustomIntegrations",
          "description": [],
          "signature": [
            "() => Promise<",
            {
              "pluginId": "customIntegrations",
              "scope": "common",
              "docId": "kibCustomIntegrationsPluginApi",
              "section": "def-common.CustomIntegration",
              "text": "CustomIntegration"
            },
            "[]>"
          ],
          "path": "src/plugins/custom_integrations/public/types.ts",
          "deprecated": false,
          "children": [],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "customIntegrations",
      "id": "def-public.CustomIntegrationsStart",
      "type": "Interface",
      "tags": [],
      "label": "CustomIntegrationsStart",
      "description": [],
      "path": "src/plugins/custom_integrations/public/types.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "customIntegrations",
          "id": "def-public.CustomIntegrationsStart.ContextProvider",
          "type": "Function",
          "tags": [],
          "label": "ContextProvider",
          "description": [],
          "signature": [
            "React.FunctionComponent<{}>"
          ],
          "path": "src/plugins/custom_integrations/public/types.ts",
          "deprecated": false,
          "returnComment": [],
          "children": [
            {
              "parentPluginId": "customIntegrations",
              "id": "def-public.CustomIntegrationsStart.ContextProvider.$1",
              "type": "CompoundType",
              "tags": [],
              "label": "props",
              "description": [],
              "signature": [
                "P & { children?: React.ReactNode; }"
              ],
              "path": "node_modules/@types/react/index.d.ts",
              "deprecated": false
            },
            {
              "parentPluginId": "customIntegrations",
              "id": "def-public.CustomIntegrationsStart.ContextProvider.$2",
              "type": "Any",
              "tags": [],
              "label": "context",
              "description": [],
              "signature": [
                "any"
              ],
              "path": "node_modules/@types/react/index.d.ts",
              "deprecated": false
            }
          ]
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-server.CustomIntegration",
        "type": "Interface",
        "tags": [],
        "label": "CustomIntegration",
        "description": [
          "\nA definition of a dataintegration, which can be registered with Kibana."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.title",
            "type": "string",
            "tags": [],
            "label": "title",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "\"ui_link\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.uiInternalPath",
            "type": "string",
            "tags": [],
            "label": "uiInternalPath",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.isBeta",
            "type": "boolean",
            "tags": [],
            "label": "isBeta",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.icons",
            "type": "Array",
            "tags": [],
            "label": "icons",
            "description": [],
            "signature": [
              {
                "pluginId": "customIntegrations",
                "scope": "common",
                "docId": "kibCustomIntegrationsPluginApi",
                "section": "def-common.CustomIntegrationIcon",
                "text": "CustomIntegrationIcon"
              },
              "[]"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.categories",
            "type": "Array",
            "tags": [],
            "label": "categories",
            "description": [],
            "signature": [
              "(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.shipper",
            "type": "CompoundType",
            "tags": [],
            "label": "shipper",
            "description": [],
            "signature": [
              "\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-server.CustomIntegration.eprOverlap",
            "type": "string",
            "tags": [],
            "label": "eprOverlap",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-server.IntegrationCategory",
        "type": "Type",
        "tags": [],
        "label": "IntegrationCategory",
        "description": [
          "\nA category applicable to an Integration."
        ],
        "signature": [
          "\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "customIntegrations",
      "id": "def-server.CustomIntegrationsPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "CustomIntegrationsPluginSetup",
      "description": [],
      "path": "src/plugins/custom_integrations/server/types.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "customIntegrations",
          "id": "def-server.CustomIntegrationsPluginSetup.registerCustomIntegration",
          "type": "Function",
          "tags": [],
          "label": "registerCustomIntegration",
          "description": [],
          "signature": [
            "(customIntegration: Pick<",
            {
              "pluginId": "customIntegrations",
              "scope": "common",
              "docId": "kibCustomIntegrationsPluginApi",
              "section": "def-common.CustomIntegration",
              "text": "CustomIntegration"
            },
            ", \"shipper\" | \"id\" | \"title\" | \"description\" | \"uiInternalPath\" | \"isBeta\" | \"icons\" | \"categories\" | \"eprOverlap\">) => void"
          ],
          "path": "src/plugins/custom_integrations/server/types.ts",
          "deprecated": false,
          "children": [
            {
              "parentPluginId": "customIntegrations",
              "id": "def-server.CustomIntegrationsPluginSetup.registerCustomIntegration.$1",
              "type": "Object",
              "tags": [],
              "label": "customIntegration",
              "description": [],
              "signature": [
                "Pick<",
                {
                  "pluginId": "customIntegrations",
                  "scope": "common",
                  "docId": "kibCustomIntegrationsPluginApi",
                  "section": "def-common.CustomIntegration",
                  "text": "CustomIntegration"
                },
                ", \"shipper\" | \"id\" | \"title\" | \"description\" | \"uiInternalPath\" | \"isBeta\" | \"icons\" | \"categories\" | \"eprOverlap\">"
              ],
              "path": "src/plugins/custom_integrations/server/types.ts",
              "deprecated": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        },
        {
          "parentPluginId": "customIntegrations",
          "id": "def-server.CustomIntegrationsPluginSetup.getAppendCustomIntegrations",
          "type": "Function",
          "tags": [],
          "label": "getAppendCustomIntegrations",
          "description": [],
          "signature": [
            "() => ",
            {
              "pluginId": "customIntegrations",
              "scope": "common",
              "docId": "kibCustomIntegrationsPluginApi",
              "section": "def-common.CustomIntegration",
              "text": "CustomIntegration"
            },
            "[]"
          ],
          "path": "src/plugins/custom_integrations/server/types.ts",
          "deprecated": false,
          "children": [],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "customIntegrations",
      "id": "def-server.CustomIntegrationsPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "CustomIntegrationsPluginStart",
      "description": [],
      "path": "src/plugins/custom_integrations/server/types.ts",
      "deprecated": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.CustomIntegration",
        "type": "Interface",
        "tags": [],
        "label": "CustomIntegration",
        "description": [
          "\nA definition of a dataintegration, which can be registered with Kibana."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.title",
            "type": "string",
            "tags": [],
            "label": "title",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "\"ui_link\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.uiInternalPath",
            "type": "string",
            "tags": [],
            "label": "uiInternalPath",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.isBeta",
            "type": "boolean",
            "tags": [],
            "label": "isBeta",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.icons",
            "type": "Array",
            "tags": [],
            "label": "icons",
            "description": [],
            "signature": [
              {
                "pluginId": "customIntegrations",
                "scope": "common",
                "docId": "kibCustomIntegrationsPluginApi",
                "section": "def-common.CustomIntegrationIcon",
                "text": "CustomIntegrationIcon"
              },
              "[]"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.categories",
            "type": "Array",
            "tags": [],
            "label": "categories",
            "description": [],
            "signature": [
              "(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.shipper",
            "type": "CompoundType",
            "tags": [],
            "label": "shipper",
            "description": [],
            "signature": [
              "\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegration.eprOverlap",
            "type": "string",
            "tags": [],
            "label": "eprOverlap",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.CustomIntegrationIcon",
        "type": "Interface",
        "tags": [],
        "label": "CustomIntegrationIcon",
        "description": [
          "\nAn icon representing an Integration."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegrationIcon.src",
            "type": "string",
            "tags": [],
            "label": "src",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.CustomIntegrationIcon.type",
            "type": "CompoundType",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "\"eui\" | \"svg\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.IntegrationCategoryCount",
        "type": "Interface",
        "tags": [],
        "label": "IntegrationCategoryCount",
        "description": [
          "\nAn object containing the id of an `IntegrationCategory` and the count of all Integrations in that category."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.IntegrationCategoryCount.count",
            "type": "number",
            "tags": [],
            "label": "count",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.IntegrationCategoryCount.id",
            "type": "CompoundType",
            "tags": [],
            "label": "id",
            "description": [],
            "signature": [
              "\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.category",
        "type": "Array",
        "tags": [],
        "label": "category",
        "description": [
          "\nThe list of all available categories."
        ],
        "signature": [
          "(\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\")[]"
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.IntegrationCategory",
        "type": "Type",
        "tags": [],
        "label": "IntegrationCategory",
        "description": [
          "\nA category applicable to an Integration."
        ],
        "signature": [
          "\"custom\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"language_client\""
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.PLUGIN_ID",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_ID",
        "description": [],
        "signature": [
          "\"customIntegrations\""
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.PLUGIN_NAME",
        "type": "string",
        "tags": [],
        "label": "PLUGIN_NAME",
        "description": [],
        "signature": [
          "\"customIntegrations\""
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.ROUTES_APPEND_CUSTOM_INTEGRATIONS",
        "type": "string",
        "tags": [],
        "label": "ROUTES_APPEND_CUSTOM_INTEGRATIONS",
        "description": [],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.ROUTES_REPLACEMENT_CUSTOM_INTEGRATIONS",
        "type": "string",
        "tags": [],
        "label": "ROUTES_REPLACEMENT_CUSTOM_INTEGRATIONS",
        "description": [],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.shipper",
        "type": "Array",
        "tags": [],
        "label": "shipper",
        "description": [
          "\nThe list of all known shippers."
        ],
        "signature": [
          "(\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\")[]"
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.Shipper",
        "type": "Type",
        "tags": [],
        "label": "Shipper",
        "description": [
          "\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration."
        ],
        "signature": [
          "\"beats\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\""
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.INTEGRATION_CATEGORY_DISPLAY",
        "type": "Object",
        "tags": [],
        "label": "INTEGRATION_CATEGORY_DISPLAY",
        "description": [
          "\nA map of category names and their corresponding titles."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.aws",
            "type": "string",
            "tags": [],
            "label": "aws",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.azure",
            "type": "string",
            "tags": [],
            "label": "azure",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.cloud",
            "type": "string",
            "tags": [],
            "label": "cloud",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.config_management",
            "type": "string",
            "tags": [],
            "label": "config_management",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.containers",
            "type": "string",
            "tags": [],
            "label": "containers",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.crm",
            "type": "string",
            "tags": [],
            "label": "crm",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.custom",
            "type": "string",
            "tags": [],
            "label": "custom",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.datastore",
            "type": "string",
            "tags": [],
            "label": "datastore",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.elastic_stack",
            "type": "string",
            "tags": [],
            "label": "elastic_stack",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.google_cloud",
            "type": "string",
            "tags": [],
            "label": "google_cloud",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.kubernetes",
            "type": "string",
            "tags": [],
            "label": "kubernetes",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.languages",
            "type": "string",
            "tags": [],
            "label": "languages",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.message_queue",
            "type": "string",
            "tags": [],
            "label": "message_queue",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.monitoring",
            "type": "string",
            "tags": [],
            "label": "monitoring",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.network",
            "type": "string",
            "tags": [],
            "label": "network",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.notification",
            "type": "string",
            "tags": [],
            "label": "notification",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.os_system",
            "type": "string",
            "tags": [],
            "label": "os_system",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.productivity",
            "type": "string",
            "tags": [],
            "label": "productivity",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.security",
            "type": "string",
            "tags": [],
            "label": "security",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.sample_data",
            "type": "string",
            "tags": [],
            "label": "sample_data",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.support",
            "type": "string",
            "tags": [],
            "label": "support",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing",
            "type": "string",
            "tags": [],
            "label": "ticketing",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.version_control",
            "type": "string",
            "tags": [],
            "label": "version_control",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.web",
            "type": "string",
            "tags": [],
            "label": "web",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file",
            "type": "string",
            "tags": [],
            "label": "upload_file",
            "description": [
              "// Kibana added"
            ],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.language_client",
            "type": "string",
            "tags": [],
            "label": "language_client",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "customIntegrations",
        "id": "def-common.SHIPPER_DISPLAY",
        "type": "Object",
        "tags": [],
        "label": "SHIPPER_DISPLAY",
        "description": [
          "\nA map of shipper names and their corresponding titles."
        ],
        "path": "src/plugins/custom_integrations/common/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.beats",
            "type": "string",
            "tags": [],
            "label": "beats",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.language_clients",
            "type": "string",
            "tags": [],
            "label": "language_clients",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.other",
            "type": "string",
            "tags": [],
            "label": "other",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.sample_data",
            "type": "string",
            "tags": [],
            "label": "sample_data",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.tests",
            "type": "string",
            "tags": [],
            "label": "tests",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "customIntegrations",
            "id": "def-common.SHIPPER_DISPLAY.tutorial",
            "type": "string",
            "tags": [],
            "label": "tutorial",
            "description": [],
            "path": "src/plugins/custom_integrations/common/index.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}