kibana/api_docs/ingest_pipelines.json

{
  "id": "ingestPipelines",
  "client": {
    "classes": [
      {
        "parentPluginId": "ingestPipelines",
        "id": "def-public.IngestPipelinesUrlGenerator",
        "type": "Class",
        "tags": [],
        "label": "IngestPipelinesUrlGenerator",
        "description": [],
        "signature": [
          {
            "pluginId": "ingestPipelines",
            "scope": "public",
            "docId": "kibIngestPipelinesPluginApi",
            "section": "def-public.IngestPipelinesUrlGenerator",
            "text": "IngestPipelinesUrlGenerator"
          },
          " implements ",
          {
            "pluginId": "share",
            "scope": "public",
            "docId": "kibSharePluginApi",
            "section": "def-public.UrlGeneratorsDefinition",
            "text": "UrlGeneratorsDefinition"
          },
          "<\"INGEST_PIPELINES_APP_URL_GENERATOR\">"
        ],
        "source": {
          "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
          "lineNumber": 55
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "ingestPipelines",
            "id": "def-public.IngestPipelinesUrlGenerator.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "source": {
              "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
              "lineNumber": 57
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "ingestPipelines",
                "id": "def-public.IngestPipelinesUrlGenerator.Unnamed.$1",
                "type": "Function",
                "tags": [],
                "label": "getAppBasePath",
                "description": [],
                "signature": [
                  "(absolute: boolean) => Promise<string>"
                ],
                "source": {
                  "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
                  "lineNumber": 57
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "ingestPipelines",
            "id": "def-public.IngestPipelinesUrlGenerator.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "signature": [
              "\"INGEST_PIPELINES_APP_URL_GENERATOR\""
            ],
            "source": {
              "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
              "lineNumber": 59
            },
            "deprecated": false
          },
          {
            "parentPluginId": "ingestPipelines",
            "id": "def-public.IngestPipelinesUrlGenerator.createUrl",
            "type": "Function",
            "tags": [],
            "label": "createUrl",
            "description": [],
            "signature": [
              "(state: ",
              {
                "pluginId": "ingestPipelines",
                "scope": "public",
                "docId": "kibIngestPipelinesPluginApi",
                "section": "def-public.IngestPipelinesUrlGeneratorState",
                "text": "IngestPipelinesUrlGeneratorState"
              },
              ") => Promise<string>"
            ],
            "source": {
              "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
              "lineNumber": 61
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "ingestPipelines",
                "id": "def-public.IngestPipelinesUrlGenerator.createUrl.$1",
                "type": "CompoundType",
                "tags": [],
                "label": "state",
                "description": [],
                "signature": [
                  {
                    "pluginId": "ingestPipelines",
                    "scope": "public",
                    "docId": "kibIngestPipelinesPluginApi",
                    "section": "def-public.IngestPipelinesUrlGeneratorState",
                    "text": "IngestPipelinesUrlGeneratorState"
                  }
                ],
                "source": {
                  "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
                  "lineNumber": 61
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [],
    "enums": [
      {
        "parentPluginId": "ingestPipelines",
        "id": "def-public.INGEST_PIPELINES_PAGES",
        "type": "Enum",
        "tags": [],
        "label": "INGEST_PIPELINES_PAGES",
        "description": [],
        "source": {
          "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
          "lineNumber": 22
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "misc": [
      {
        "parentPluginId": "ingestPipelines",
        "id": "def-public.INGEST_PIPELINES_APP_ULR_GENERATOR",
        "type": "string",
        "tags": [],
        "label": "INGEST_PIPELINES_APP_ULR_GENERATOR",
        "description": [],
        "signature": [
          "\"INGEST_PIPELINES_APP_URL_GENERATOR\""
        ],
        "source": {
          "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
          "lineNumber": 20
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "ingestPipelines",
        "id": "def-public.IngestPipelinesUrlGeneratorState",
        "type": "Type",
        "tags": [],
        "label": "IngestPipelinesUrlGeneratorState",
        "description": [],
        "signature": [
          "PipelinesListUrlGeneratorState",
          " | ",
          "PipelineEditUrlGeneratorState",
          " | ",
          "PipelineCloneUrlGeneratorState",
          " | ",
          "PipelineCreateUrlGeneratorState"
        ],
        "source": {
          "path": "x-pack/plugins/ingest_pipelines/public/url_generator.ts",
          "lineNumber": 49
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}