kibana/api_docs/observability_log_explorer.devdocs.json

{
  "id": "observabilityLogExplorer",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [
      {
        "parentPluginId": "observabilityLogExplorer",
        "id": "def-common.AllDatasetsLocatorDefinition",
        "type": "Class",
        "tags": [],
        "label": "AllDatasetsLocatorDefinition",
        "description": [],
        "signature": [
          {
            "pluginId": "observabilityLogExplorer",
            "scope": "common",
            "docId": "kibObservabilityLogExplorerPluginApi",
            "section": "def-common.AllDatasetsLocatorDefinition",
            "text": "AllDatasetsLocatorDefinition"
          },
          " implements ",
          {
            "pluginId": "share",
            "scope": "common",
            "docId": "kibSharePluginApi",
            "section": "def-common.LocatorDefinition",
            "text": "LocatorDefinition"
          },
          "<",
          {
            "pluginId": "@kbn/deeplinks-observability",
            "scope": "common",
            "docId": "kibKbnDeeplinksObservabilityPluginApi",
            "section": "def-common.LogExplorerNavigationParams",
            "text": "LogExplorerNavigationParams"
          },
          ">"
        ],
        "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.AllDatasetsLocatorDefinition.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "signature": [
              "\"ALL_DATASETS_LOCATOR\""
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.AllDatasetsLocatorDefinition.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "observabilityLogExplorer",
                "id": "def-common.AllDatasetsLocatorDefinition.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "deps",
                "description": [],
                "signature": [
                  "DatasetLocatorDependencies"
                ],
                "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.AllDatasetsLocatorDefinition.getLocation",
            "type": "Function",
            "tags": [],
            "label": "getLocation",
            "description": [],
            "signature": [
              "(params: ",
              {
                "pluginId": "@kbn/deeplinks-observability",
                "scope": "common",
                "docId": "kibKbnDeeplinksObservabilityPluginApi",
                "section": "def-common.LogExplorerNavigationParams",
                "text": "LogExplorerNavigationParams"
              },
              ") => Promise<{ app: string; path: string; state: {}; }>"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "observabilityLogExplorer",
                "id": "def-common.AllDatasetsLocatorDefinition.getLocation.$1",
                "type": "Object",
                "tags": [],
                "label": "params",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/deeplinks-observability",
                    "scope": "common",
                    "docId": "kibKbnDeeplinksObservabilityPluginApi",
                    "section": "def-common.LogExplorerNavigationParams",
                    "text": "LogExplorerNavigationParams"
                  }
                ],
                "path": "x-pack/plugins/observability_log_explorer/common/locators/all_datasets/all_datasets_locator.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "observabilityLogExplorer",
        "id": "def-common.SingleDatasetLocatorDefinition",
        "type": "Class",
        "tags": [],
        "label": "SingleDatasetLocatorDefinition",
        "description": [],
        "signature": [
          {
            "pluginId": "observabilityLogExplorer",
            "scope": "common",
            "docId": "kibObservabilityLogExplorerPluginApi",
            "section": "def-common.SingleDatasetLocatorDefinition",
            "text": "SingleDatasetLocatorDefinition"
          },
          " implements ",
          {
            "pluginId": "share",
            "scope": "common",
            "docId": "kibSharePluginApi",
            "section": "def-common.LocatorDefinition",
            "text": "LocatorDefinition"
          },
          "<",
          {
            "pluginId": "@kbn/deeplinks-observability",
            "scope": "common",
            "docId": "kibKbnDeeplinksObservabilityPluginApi",
            "section": "def-common.SingleDatasetLocatorParams",
            "text": "SingleDatasetLocatorParams"
          },
          ">"
        ],
        "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.SingleDatasetLocatorDefinition.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "signature": [
              "\"SINGLE_DATASET_LOCATOR\""
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.SingleDatasetLocatorDefinition.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "observabilityLogExplorer",
                "id": "def-common.SingleDatasetLocatorDefinition.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "deps",
                "description": [],
                "signature": [
                  "DatasetLocatorDependencies"
                ],
                "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.SingleDatasetLocatorDefinition.getLocation",
            "type": "Function",
            "tags": [],
            "label": "getLocation",
            "description": [],
            "signature": [
              "(params: ",
              {
                "pluginId": "@kbn/deeplinks-observability",
                "scope": "common",
                "docId": "kibKbnDeeplinksObservabilityPluginApi",
                "section": "def-common.SingleDatasetLocatorParams",
                "text": "SingleDatasetLocatorParams"
              },
              ") => Promise<{ app: string; path: string; state: {}; }>"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "observabilityLogExplorer",
                "id": "def-common.SingleDatasetLocatorDefinition.getLocation.$1",
                "type": "Object",
                "tags": [],
                "label": "params",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/deeplinks-observability",
                    "scope": "common",
                    "docId": "kibKbnDeeplinksObservabilityPluginApi",
                    "section": "def-common.SingleDatasetLocatorParams",
                    "text": "SingleDatasetLocatorParams"
                  }
                ],
                "path": "x-pack/plugins/observability_log_explorer/common/locators/single_dataset/single_dataset_locator.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "observabilityLogExplorer",
        "id": "def-common.ObservabilityLogExplorerLocators",
        "type": "Interface",
        "tags": [],
        "label": "ObservabilityLogExplorerLocators",
        "description": [],
        "path": "x-pack/plugins/observability_log_explorer/common/locators/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.ObservabilityLogExplorerLocators.allDatasetsLocator",
            "type": "Object",
            "tags": [],
            "label": "allDatasetsLocator",
            "description": [],
            "signature": [
              {
                "pluginId": "share",
                "scope": "common",
                "docId": "kibSharePluginApi",
                "section": "def-common.LocatorPublic",
                "text": "LocatorPublic"
              },
              "<",
              {
                "pluginId": "@kbn/deeplinks-observability",
                "scope": "common",
                "docId": "kibKbnDeeplinksObservabilityPluginApi",
                "section": "def-common.LogExplorerNavigationParams",
                "text": "LogExplorerNavigationParams"
              },
              ">"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/index.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "observabilityLogExplorer",
            "id": "def-common.ObservabilityLogExplorerLocators.singleDatasetLocator",
            "type": "Object",
            "tags": [],
            "label": "singleDatasetLocator",
            "description": [],
            "signature": [
              {
                "pluginId": "share",
                "scope": "common",
                "docId": "kibSharePluginApi",
                "section": "def-common.LocatorPublic",
                "text": "LocatorPublic"
              },
              "<",
              {
                "pluginId": "@kbn/deeplinks-observability",
                "scope": "common",
                "docId": "kibKbnDeeplinksObservabilityPluginApi",
                "section": "def-common.SingleDatasetLocatorParams",
                "text": "SingleDatasetLocatorParams"
              },
              ">"
            ],
            "path": "x-pack/plugins/observability_log_explorer/common/locators/index.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}