kibana/api_docs/kbn_data_forge.devdocs.json

{
  "id": "@kbn/data-forge",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.cleanup",
        "type": "Function",
        "tags": [],
        "label": "cleanup",
        "description": [],
        "signature": [
          "({\n  client,\n  config: partialConfig,\n  logger,\n}: { client: ",
          "default",
          "; config: { elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }; logger: ",
          {
            "pluginId": "@kbn/tooling-log",
            "scope": "common",
            "docId": "kibKbnToolingLogPluginApi",
            "section": "def-common.ToolingLog",
            "text": "ToolingLog"
          },
          "; }) => Promise<void>"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cleanup.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.cleanup.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  client,\n  config: partialConfig,\n  logger,\n}",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cleanup.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.cleanup.$1.client",
                "type": "Object",
                "tags": [],
                "label": "client",
                "description": [],
                "signature": [
                  "default"
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cleanup.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.cleanup.$1.config",
                "type": "Object",
                "tags": [],
                "label": "config",
                "description": [],
                "signature": [
                  "{ elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }"
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cleanup.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.cleanup.$1.logger",
                "type": "Object",
                "tags": [],
                "label": "logger",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/tooling-log",
                    "scope": "common",
                    "docId": "kibKbnToolingLogPluginApi",
                    "section": "def-common.ToolingLog",
                    "text": "ToolingLog"
                  }
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cleanup.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.cli",
        "type": "Function",
        "tags": [],
        "label": "cli",
        "description": [],
        "signature": [
          "(cliOptions: ",
          "CliOptions",
          " | undefined) => Promise<string[]>"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cli.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.cli.$1",
            "type": "Object",
            "tags": [],
            "label": "cliOptions",
            "description": [],
            "signature": [
              "CliOptions",
              " | undefined"
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/cli.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.createConfig",
        "type": "Function",
        "tags": [],
        "label": "createConfig",
        "description": [],
        "signature": [
          "(partialConfig: { elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }) => { elasticsearch: { host: string; username: string; password: string; apiKey: string; installKibanaUser: boolean; }; kibana: { host: string; username: string; password: string; installAssets: boolean; }; indexing: { dataset: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\"; scenario: string; interval: number; eventsPerCycle: number; payloadSize: number; concurrency: number; reduceWeekendTrafficBy: number; ephemeralProjectIds: number; alignEventsToInterval: boolean; artificialIndexDelay: number; slashLogs: boolean; }; schedule: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[]; }"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/lib/create_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.createConfig.$1",
            "type": "Object",
            "tags": [],
            "label": "partialConfig",
            "description": [],
            "signature": [
              "{ elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }"
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/lib/create_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.generate",
        "type": "Function",
        "tags": [],
        "label": "generate",
        "description": [],
        "signature": [
          "({ client, config: partialConfig, logger, }: { client: ",
          "default",
          "; config: { elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }; logger: ",
          {
            "pluginId": "@kbn/tooling-log",
            "scope": "common",
            "docId": "kibKbnToolingLogPluginApi",
            "section": "def-common.ToolingLog",
            "text": "ToolingLog"
          },
          "; }) => Promise<string[]>"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/generate.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.generate.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  client,\n  config: partialConfig,\n  logger,\n}",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/generate.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.generate.$1.client",
                "type": "Object",
                "tags": [],
                "label": "client",
                "description": [],
                "signature": [
                  "default"
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/generate.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.generate.$1.config",
                "type": "Object",
                "tags": [],
                "label": "config",
                "description": [],
                "signature": [
                  "{ elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }"
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/generate.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-forge",
                "id": "def-common.generate.$1.logger",
                "type": "Object",
                "tags": [],
                "label": "logger",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/tooling-log",
                    "scope": "common",
                    "docId": "kibKbnToolingLogPluginApi",
                    "section": "def-common.ToolingLog",
                    "text": "ToolingLog"
                  }
                ],
                "path": "x-pack/platform/packages/shared/kbn-data-forge/src/generate.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.readConfig",
        "type": "Function",
        "tags": [],
        "label": "readConfig",
        "description": [],
        "signature": [
          "(filePath: string) => Promise<{ elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }>"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/lib/create_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.readConfig.$1",
            "type": "string",
            "tags": [],
            "label": "filePath",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/lib/create_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.run",
        "type": "Function",
        "tags": [],
        "label": "run",
        "description": [],
        "signature": [
          "(config: { elasticsearch: { host: string; username: string; password: string; apiKey: string; installKibanaUser: boolean; }; kibana: { host: string; username: string; password: string; installAssets: boolean; }; indexing: { dataset: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\"; scenario: string; interval: number; eventsPerCycle: number; payloadSize: number; concurrency: number; reduceWeekendTrafficBy: number; ephemeralProjectIds: number; alignEventsToInterval: boolean; artificialIndexDelay: number; slashLogs: boolean; }; schedule: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[]; }, client: ",
          "default",
          ", logger: ",
          {
            "pluginId": "@kbn/tooling-log",
            "scope": "common",
            "docId": "kibKbnToolingLogPluginApi",
            "section": "def-common.ToolingLog",
            "text": "ToolingLog"
          },
          ") => Promise<string[]>"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/run.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.run.$1",
            "type": "Object",
            "tags": [],
            "label": "config",
            "description": [],
            "signature": [
              "{ elasticsearch: { host: string; username: string; password: string; apiKey: string; installKibanaUser: boolean; }; kibana: { host: string; username: string; password: string; installAssets: boolean; }; indexing: { dataset: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\"; scenario: string; interval: number; eventsPerCycle: number; payloadSize: number; concurrency: number; reduceWeekendTrafficBy: number; ephemeralProjectIds: number; alignEventsToInterval: boolean; artificialIndexDelay: number; slashLogs: boolean; }; schedule: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[]; }"
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/run.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.run.$2",
            "type": "Object",
            "tags": [],
            "label": "client",
            "description": [],
            "signature": [
              "default"
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/run.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.run.$3",
            "type": "Object",
            "tags": [],
            "label": "logger",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/tooling-log",
                "scope": "common",
                "docId": "kibKbnToolingLogPluginApi",
                "section": "def-common.ToolingLog",
                "text": "ToolingLog"
              }
            ],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/run.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.Config",
        "type": "Type",
        "tags": [],
        "label": "Config",
        "description": [],
        "signature": [
          "{ elasticsearch: { host: string; username: string; password: string; apiKey: string; installKibanaUser: boolean; }; kibana: { host: string; username: string; password: string; installAssets: boolean; }; indexing: { dataset: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\"; scenario: string; interval: number; eventsPerCycle: number; payloadSize: number; concurrency: number; reduceWeekendTrafficBy: number; ephemeralProjectIds: number; alignEventsToInterval: boolean; artificialIndexDelay: number; slashLogs: boolean; }; schedule: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[]; }"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.Dataset",
        "type": "Type",
        "tags": [],
        "label": "Dataset",
        "description": [],
        "signature": [
          "\"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\""
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.EventsPerCycle",
        "type": "Type",
        "tags": [],
        "label": "EventsPerCycle",
        "description": [],
        "signature": [
          "number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; })"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.MetricEventDef",
        "type": "Type",
        "tags": [],
        "label": "MetricEventDef",
        "description": [],
        "signature": [
          "{ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; }"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.PartialConfig",
        "type": "Type",
        "tags": [],
        "label": "PartialConfig",
        "description": [],
        "signature": [
          "{ elasticsearch?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; apiKey?: string | undefined; installKibanaUser?: boolean | undefined; } | undefined; kibana?: { host?: string | undefined; username?: string | undefined; password?: string | undefined; installAssets?: boolean | undefined; } | undefined; indexing?: { dataset?: \"fake_hosts\" | \"fake_logs\" | \"fake_stack\" | \"service.logs\" | undefined; scenario?: string | undefined; interval?: number | undefined; eventsPerCycle?: number | undefined; payloadSize?: number | undefined; concurrency?: number | undefined; reduceWeekendTrafficBy?: number | undefined; ephemeralProjectIds?: number | undefined; alignEventsToInterval?: boolean | undefined; artificialIndexDelay?: number | undefined; slashLogs?: boolean | undefined; } | undefined; schedule?: ({ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; })[] | undefined; }"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.Schedule",
        "type": "Type",
        "tags": [],
        "label": "Schedule",
        "description": [],
        "signature": [
          "{ template: string; start: string; end: string | boolean; } & { eventsPerCycle?: number | ({ start: number; end: number; method: \"linear\" | \"exp\" | \"sine\"; } & { options?: { period?: number | undefined; } | undefined; }) | undefined; interval?: number | undefined; delayInMinutes?: number | undefined; delayEveryMinutes?: number | undefined; randomness?: number | undefined; metrics?: ({ name: string; method: \"linear\" | \"exp\" | \"sine\"; start: number; end: number; } & { period?: number | undefined; randomness?: number | undefined; })[] | undefined; }"
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.TransitionMethod",
        "type": "Type",
        "tags": [],
        "label": "TransitionMethod",
        "description": [],
        "signature": [
          "\"linear\" | \"exp\" | \"sine\""
        ],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/types/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/data-forge",
        "id": "def-common.DEFAULTS",
        "type": "Object",
        "tags": [],
        "label": "DEFAULTS",
        "description": [],
        "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.EVENTS_PER_CYCLE",
            "type": "number",
            "tags": [],
            "label": "EVENTS_PER_CYCLE",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.PAYLOAD_SIZE",
            "type": "number",
            "tags": [],
            "label": "PAYLOAD_SIZE",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.CONCURRENCY",
            "type": "number",
            "tags": [],
            "label": "CONCURRENCY",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.SERVERLESS",
            "type": "boolean",
            "tags": [],
            "label": "SERVERLESS",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.INDEX_INTERVAL",
            "type": "number",
            "tags": [],
            "label": "INDEX_INTERVAL",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.DATASET",
            "type": "string",
            "tags": [],
            "label": "DATASET",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.SCENARIO",
            "type": "string",
            "tags": [],
            "label": "SCENARIO",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.ELASTICSEARCH_HOST",
            "type": "string",
            "tags": [],
            "label": "ELASTICSEARCH_HOST",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.ELASTICSEARCH_USERNAME",
            "type": "string",
            "tags": [],
            "label": "ELASTICSEARCH_USERNAME",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.ELASTICSEARCH_PASSWORD",
            "type": "string",
            "tags": [],
            "label": "ELASTICSEARCH_PASSWORD",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.ELASTICSEARCH_API_KEY",
            "type": "string",
            "tags": [],
            "label": "ELASTICSEARCH_API_KEY",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.SKIP_KIBANA_USER",
            "type": "boolean",
            "tags": [],
            "label": "SKIP_KIBANA_USER",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.INSTALL_KIBANA_ASSETS",
            "type": "boolean",
            "tags": [],
            "label": "INSTALL_KIBANA_ASSETS",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.DELAY_IN_MINUTES",
            "type": "number",
            "tags": [],
            "label": "DELAY_IN_MINUTES",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.DELAY_EVERY_MINUTES",
            "type": "number",
            "tags": [],
            "label": "DELAY_EVERY_MINUTES",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.LOOKBACK",
            "type": "string",
            "tags": [],
            "label": "LOOKBACK",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.KIBANA_URL",
            "type": "string",
            "tags": [],
            "label": "KIBANA_URL",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.KIBANA_USERNAME",
            "type": "string",
            "tags": [],
            "label": "KIBANA_USERNAME",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.KIBANA_PASSWORD",
            "type": "string",
            "tags": [],
            "label": "KIBANA_PASSWORD",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.EVENT_TEMPLATE",
            "type": "string",
            "tags": [],
            "label": "EVENT_TEMPLATE",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.REDUCE_WEEKEND_TRAFFIC_BY",
            "type": "number",
            "tags": [],
            "label": "REDUCE_WEEKEND_TRAFFIC_BY",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.EPHEMERAL_PROJECT_IDS",
            "type": "number",
            "tags": [],
            "label": "EPHEMERAL_PROJECT_IDS",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.ALIGN_EVENTS_TO_INTERVAL",
            "type": "boolean",
            "tags": [],
            "label": "ALIGN_EVENTS_TO_INTERVAL",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.CARDINALITY",
            "type": "number",
            "tags": [],
            "label": "CARDINALITY",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/data-forge",
            "id": "def-common.DEFAULTS.SLASH_LOGS",
            "type": "boolean",
            "tags": [],
            "label": "SLASH_LOGS",
            "description": [],
            "path": "x-pack/platform/packages/shared/kbn-data-forge/src/constants.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}