kibana/api_docs/snapshot_restore.json
Stacey Gammon 4bfb35b43a
Update api docs (#116495)
* update api docs

* update api docs
2021-11-01 19:16:16 +00:00

365 lines
11 KiB
JSON

{
"id": "snapshotRestore",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_TYPES",
"type": "Enum",
"tags": [],
"label": "REPOSITORY_TYPES",
"description": [],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.API_BASE_PATH",
"type": "string",
"tags": [],
"label": "API_BASE_PATH",
"description": [],
"signature": [
"\"/api/snapshot_restore/\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_REQUIRED_CLUSTER_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_REQUIRED_CLUSTER_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_RESTORE_INDEX_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_RESTORE_INDEX_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.APP_SLM_CLUSTER_PRIVILEGES",
"type": "Array",
"tags": [],
"label": "APP_SLM_CLUSTER_PRIVILEGES",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.DEFAULT_REPOSITORY_TYPES",
"type": "Array",
"tags": [],
"label": "DEFAULT_REPOSITORY_TYPES",
"description": [],
"signature": [
"RepositoryType",
"[]"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.MAJOR_VERSION",
"type": "string",
"tags": [],
"label": "MAJOR_VERSION",
"description": [],
"signature": [
"\"8.0.0\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN_REPOSITORY_TYPES",
"type": "Array",
"tags": [],
"label": "PLUGIN_REPOSITORY_TYPES",
"description": [],
"signature": [
"RepositoryType",
"[]"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN",
"type": "Object",
"tags": [],
"label": "PLUGIN",
"description": [],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.minimumLicenseType",
"type": "string",
"tags": [],
"label": "minimumLicenseType",
"description": [],
"signature": [
"\"basic\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.getI18nName",
"type": "Function",
"tags": [],
"label": "getI18nName",
"description": [],
"signature": [
"(i18n: any) => string"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.PLUGIN.getI18nName.$1",
"type": "Any",
"tags": [],
"label": "i18n",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP",
"type": "Object",
"tags": [],
"label": "REPOSITORY_PLUGINS_MAP",
"description": [],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorys3",
"type": "string",
"tags": [],
"label": "'repository-s3'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".s3"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryhdfs",
"type": "string",
"tags": [],
"label": "'repository-hdfs'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".hdfs"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositoryazure",
"type": "string",
"tags": [],
"label": "'repository-azure'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".azure"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.REPOSITORY_PLUGINS_MAP.repositorygcs",
"type": "string",
"tags": [],
"label": "'repository-gcs'",
"description": [],
"signature": [
{
"pluginId": "snapshotRestore",
"scope": "common",
"docId": "kibSnapshotRestorePluginApi",
"section": "def-common.REPOSITORY_TYPES",
"text": "REPOSITORY_TYPES"
},
".gcs"
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS",
"type": "Object",
"tags": [],
"label": "TIME_UNITS",
"description": [],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.DAY",
"type": "string",
"tags": [],
"label": "DAY",
"description": [],
"signature": [
"\"d\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.HOUR",
"type": "string",
"tags": [],
"label": "HOUR",
"description": [],
"signature": [
"\"h\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.MINUTE",
"type": "string",
"tags": [],
"label": "MINUTE",
"description": [],
"signature": [
"\"m\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
},
{
"parentPluginId": "snapshotRestore",
"id": "def-common.TIME_UNITS.SECOND",
"type": "string",
"tags": [],
"label": "SECOND",
"description": [],
"signature": [
"\"s\""
],
"path": "x-pack/plugins/snapshot_restore/common/constants.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}