2822 lines
94 KiB
JSON
2822 lines
94 KiB
JSON
{
|
|
"id": "licensing",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ILicense",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.uid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uid",
|
|
"description": [
|
|
"\nUID for license."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe validity status of the license."
|
|
],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.isActive",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isActive",
|
|
"description": [
|
|
"\nDetermine if the status of the license is active."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.expiryDateInMillis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "expiryDateInMillis",
|
|
"description": [
|
|
"\nUnix epoch of the expiration date of the license."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.mode",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "mode",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": true,
|
|
"references": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.signature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "signature",
|
|
"description": [
|
|
"\nSignature of the license content."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.isAvailable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAvailable",
|
|
"description": [
|
|
"\nDetermine if the license container has information."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.toJSON",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toJSON",
|
|
"description": [
|
|
"\nReturns"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"PublicLicenseJSON"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.error",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"\nA potential error denoting the failure of the license from being retrieved."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.getUnavailableReason",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUnavailableReason",
|
|
"description": [
|
|
"\nIf the license is not available, provides a string or Error containing the reason."
|
|
],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.hasAtLeast",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasAtLeast",
|
|
"description": [
|
|
"\nDetermine if license type >= minimal required license type."
|
|
],
|
|
"signature": [
|
|
"(minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.hasAtLeast.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [
|
|
"the minimum valid license required for the given feature"
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.check",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "check",
|
|
"description": [
|
|
"\nFor a given plugin and license type, receive information about the status of the license."
|
|
],
|
|
"signature": [
|
|
"(pluginName: string, minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => ",
|
|
"LicenseCheck"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.check.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pluginName",
|
|
"description": [
|
|
"the name of the plugin"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.check.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [
|
|
"the minimum valid license for operating the given plugin"
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.getFeature",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFeature",
|
|
"description": [
|
|
"\nA specific API for interacting with the specific features of the license."
|
|
],
|
|
"signature": [
|
|
"(name: string) => ",
|
|
"LicenseFeature"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.ILicense.getFeature.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"the name of the feature to interact with"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseCheck",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicenseCheck",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseCheck.state",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [
|
|
"\nThe state of checking the results of a license type meeting the license minimum."
|
|
],
|
|
"signature": [
|
|
"\"valid\" | \"invalid\" | \"unavailable\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseCheck.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"\nA message containing the reason for a license type not being valid."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseFeature",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicenseFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseFeature.isAvailable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAvailable",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseFeature.isEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isEnabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublicLicense",
|
|
"description": [
|
|
"\nSubset of license data considered as non-sensitive information.\nCan be passed to the client."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense.uid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uid",
|
|
"description": [
|
|
"\nUID for license."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe validity status of the license."
|
|
],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense.expiryDateInMillis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "expiryDateInMillis",
|
|
"description": [
|
|
"\nUnix epoch of the expiration date of the license."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicense.mode",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "mode",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/handlers.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/handlers.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicenseJSON",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublicLicenseJSON",
|
|
"description": [
|
|
"\nSubset of license & features data considered as non-sensitive information.\nStructured as json to be passed to the client."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicenseJSON.license",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicLicense",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicenseJSON.features",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"LicenseFeature",
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicLicenseJSON.signature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "signature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseCheckState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseCheckState",
|
|
"description": [],
|
|
"signature": [
|
|
"\"valid\" | \"invalid\" | \"unavailable\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicenseType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.PublicFeatures",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicFeatures",
|
|
"description": [
|
|
"\nProvides information about feature availability for the current license."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
"LicenseFeature",
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicensingPluginSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginSetup.license$",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "license$",
|
|
"description": [
|
|
"\nSteam of licensing information {@link ILicense}."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/public/plugin.tsx"
|
|
},
|
|
{
|
|
"plugin": "licenseManagement",
|
|
"path": "x-pack/plugins/license_management/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/public/application/license/check_license.tsx"
|
|
},
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "fleet",
|
|
"path": "x-pack/plugins/fleet/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/public/context/license/license_context.tsx"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.tsx"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/public/share_context_menu/index.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/public/management/index.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "crossClusterReplication",
|
|
"path": "x-pack/plugins/cross_cluster_replication/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "logstash",
|
|
"path": "x-pack/plugins/logstash/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "painlessLab",
|
|
"path": "x-pack/plugins/painless_lab/public/plugin.tsx"
|
|
},
|
|
{
|
|
"plugin": "painlessLab",
|
|
"path": "x-pack/plugins/painless_lab/public/plugin.tsx"
|
|
},
|
|
{
|
|
"plugin": "searchprofiler",
|
|
"path": "x-pack/plugins/searchprofiler/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "searchprofiler",
|
|
"path": "x-pack/plugins/searchprofiler/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "watcher",
|
|
"path": "x-pack/plugins/watcher/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "watcher",
|
|
"path": "x-pack/plugins/watcher/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/public/panel_actions/get_csv_panel_action.test.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginSetup.refresh",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "refresh",
|
|
"description": [
|
|
"\nTriggers licensing information re-fetch."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": true,
|
|
"references": [],
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginSetup.featureUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureUsage",
|
|
"description": [
|
|
"\nAPIs to register licensed feature usage."
|
|
],
|
|
"signature": [
|
|
"FeatureUsageServiceSetup"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicensingPluginStart",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginStart.license$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license$",
|
|
"description": [
|
|
"\nSteam of licensing information {@link ILicense}."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginStart.refresh",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"\nTriggers licensing information re-fetch."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-public.LicensingPluginStart.featureUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureUsage",
|
|
"description": [
|
|
"\nAPIs to manage licensed feature usage."
|
|
],
|
|
"signature": [
|
|
"FeatureUsageServiceStart"
|
|
],
|
|
"path": "x-pack/plugins/licensing/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.wrapRouteWithLicenseCheck",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "wrapRouteWithLicenseCheck",
|
|
"description": [],
|
|
"signature": [
|
|
"(checkLicense: ",
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.CheckLicense",
|
|
"text": "CheckLicense"
|
|
},
|
|
", handler: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
},
|
|
"<P, Q, B, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
|
"Stream",
|
|
" | undefined>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<T>) => ",
|
|
"KibanaResponse",
|
|
"<T>; badRequest: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; unauthorized: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; forbidden: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; notFound: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; conflict: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; customError: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">) => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; redirected: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RedirectResponseOptions",
|
|
"text": "RedirectResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; ok: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; accepted: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; noContent: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<undefined>; }>) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
},
|
|
"<P, Q, B, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
|
"Stream",
|
|
" | undefined>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<T>) => ",
|
|
"KibanaResponse",
|
|
"<T>; badRequest: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; unauthorized: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; forbidden: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; notFound: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; conflict: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; customError: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">) => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; redirected: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RedirectResponseOptions",
|
|
"text": "RedirectResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; ok: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; accepted: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; noContent: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<undefined>; }>"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.wrapRouteWithLicenseCheck.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "checkLicense",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.CheckLicense",
|
|
"text": "CheckLicense"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.wrapRouteWithLicenseCheck.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RequestHandler",
|
|
"text": "RequestHandler"
|
|
},
|
|
"<P, Q, B, Context, any, { custom: <T extends string | Record<string, any> | Error | { message: string | Error; attributes?: Record<string, any> | undefined; } | Buffer | ",
|
|
"Stream",
|
|
" | undefined>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<T>) => ",
|
|
"KibanaResponse",
|
|
"<T>; badRequest: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; unauthorized: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; forbidden: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; notFound: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; conflict: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ErrorHttpResponseOptions",
|
|
"text": "ErrorHttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; customError: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.CustomHttpResponseOptions",
|
|
"text": "CustomHttpResponseOptions"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">) => ",
|
|
"KibanaResponse",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.ResponseError",
|
|
"text": "ResponseError"
|
|
},
|
|
">; redirected: (options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.RedirectResponseOptions",
|
|
"text": "RedirectResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; ok: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; accepted: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<string | Record<string, any> | Buffer | ",
|
|
"Stream",
|
|
">; noContent: (options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.HttpResponseOptions",
|
|
"text": "HttpResponseOptions"
|
|
},
|
|
") => ",
|
|
"KibanaResponse",
|
|
"<undefined>; }>"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ElasticsearchError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.ElasticsearchError",
|
|
"text": "ElasticsearchError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ElasticsearchError.status",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FeatureUsageServiceSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceSetup.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [
|
|
"\nRegister a feature to be able to notify of it's usages using the {@link FeatureUsageServiceStart | service start contract}."
|
|
],
|
|
"signature": [
|
|
"(featureName: string, licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => void"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceSetup.register.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "featureName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceSetup.register.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "licenseType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FeatureUsageServiceStart",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceStart.notifyUsage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "notifyUsage",
|
|
"description": [
|
|
"\nNotify of a registered feature usage at given time.\n"
|
|
],
|
|
"signature": [
|
|
"(featureName: string, usedAt?: number | Date | undefined) => void"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceStart.notifyUsage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "featureName",
|
|
"description": [
|
|
"- the name of the feature to notify usage of"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceStart.notifyUsage.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "usedAt",
|
|
"description": [
|
|
"- Either a `Date` or an unix timestamp with ms. If not specified, it will be set to the current time."
|
|
],
|
|
"signature": [
|
|
"number | Date | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.FeatureUsageServiceStart.getLastUsages",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLastUsages",
|
|
"description": [
|
|
"\nReturn a map containing last usage timestamp for all features.\nFeatures that were not used yet do not appear in the map."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"LastFeatureUsage",
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/services/feature_usage_service.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ILicense",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.uid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uid",
|
|
"description": [
|
|
"\nUID for license."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe validity status of the license."
|
|
],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.isActive",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isActive",
|
|
"description": [
|
|
"\nDetermine if the status of the license is active."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.expiryDateInMillis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "expiryDateInMillis",
|
|
"description": [
|
|
"\nUnix epoch of the expiration date of the license."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.mode",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "mode",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": true,
|
|
"references": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.signature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "signature",
|
|
"description": [
|
|
"\nSignature of the license content."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.isAvailable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAvailable",
|
|
"description": [
|
|
"\nDetermine if the license container has information."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.toJSON",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toJSON",
|
|
"description": [
|
|
"\nReturns"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"PublicLicenseJSON"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.error",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"\nA potential error denoting the failure of the license from being retrieved."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.getUnavailableReason",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUnavailableReason",
|
|
"description": [
|
|
"\nIf the license is not available, provides a string or Error containing the reason."
|
|
],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.hasAtLeast",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasAtLeast",
|
|
"description": [
|
|
"\nDetermine if license type >= minimal required license type."
|
|
],
|
|
"signature": [
|
|
"(minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.hasAtLeast.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [
|
|
"the minimum valid license required for the given feature"
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.check",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "check",
|
|
"description": [
|
|
"\nFor a given plugin and license type, receive information about the status of the license."
|
|
],
|
|
"signature": [
|
|
"(pluginName: string, minimumLicenseRequired: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => ",
|
|
"LicenseCheck"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.check.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pluginName",
|
|
"description": [
|
|
"the name of the plugin"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.check.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [
|
|
"the minimum valid license for operating the given plugin"
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.getFeature",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFeature",
|
|
"description": [
|
|
"\nA specific API for interacting with the specific features of the license."
|
|
],
|
|
"signature": [
|
|
"(name: string) => ",
|
|
"LicenseFeature"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.ILicense.getFeature.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"the name of the feature to interact with"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseCheck",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicenseCheck",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseCheck.state",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [
|
|
"\nThe state of checking the results of a license type meeting the license minimum."
|
|
],
|
|
"signature": [
|
|
"\"valid\" | \"invalid\" | \"unavailable\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseCheck.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"\nA message containing the reason for a license type not being valid."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseFeature",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicenseFeature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseFeature.isAvailable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isAvailable",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseFeature.isEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isEnabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicensingApiRequestHandlerContext",
|
|
"description": [
|
|
"\nThe APIs exposed on the `licensing` key of {@link RequestHandlerContext} for plugins that depend on licensing."
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingApiRequestHandlerContext.featureUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureUsage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.FeatureUsageServiceStart",
|
|
"text": "FeatureUsageServiceStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingApiRequestHandlerContext.license",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license",
|
|
"description": [],
|
|
"signature": [
|
|
"ILicense"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublicLicense",
|
|
"description": [
|
|
"\nSubset of license data considered as non-sensitive information.\nCan be passed to the client."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense.uid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uid",
|
|
"description": [
|
|
"\nUID for license."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nThe validity status of the license."
|
|
],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense.expiryDateInMillis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "expiryDateInMillis",
|
|
"description": [
|
|
"\nUnix epoch of the expiration date of the license."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicense.mode",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "mode",
|
|
"description": [
|
|
"\nThe license type, being usually one of basic, standard, gold, platinum, or trial."
|
|
],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/common/license_check.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/common/licensing/license_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/common/license/policy_config.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/handlers.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/handlers.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicenseJSON",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PublicLicenseJSON",
|
|
"description": [
|
|
"\nSubset of license & features data considered as non-sensitive information.\nStructured as json to be passed to the client."
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicenseJSON.license",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license",
|
|
"description": [],
|
|
"signature": [
|
|
"PublicLicense",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicenseJSON.features",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"LicenseFeature",
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicLicenseJSON.signature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "signature",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LICENSE_TYPE",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "LICENSE_TYPE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.CheckLicense",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CheckLicense",
|
|
"description": [],
|
|
"signature": [
|
|
"(license: ",
|
|
"ILicense",
|
|
") => { valid: false; message: string; } | { valid: true; message: null; }"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.CheckLicense.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license",
|
|
"description": [],
|
|
"signature": [
|
|
"ILicense"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseCheckState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseCheckState",
|
|
"description": [],
|
|
"signature": [
|
|
"\"valid\" | \"invalid\" | \"unavailable\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"\"invalid\" | \"active\" | \"expired\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicenseType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LicenseType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.PublicFeatures",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicFeatures",
|
|
"description": [
|
|
"\nProvides information about feature availability for the current license."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
"LicenseFeature",
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/licensing/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicensingPluginSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginSetup.license$",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "license$",
|
|
"description": [
|
|
"\nSteam of licensing information {@link ILicense}."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts"
|
|
},
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/usage/reporting_usage_collector.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/core.ts"
|
|
},
|
|
{
|
|
"plugin": "actions",
|
|
"path": "x-pack/plugins/actions/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "alerting",
|
|
"path": "x-pack/plugins/alerting/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "fleet",
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "remoteClusters",
|
|
"path": "x-pack/plugins/remote_clusters/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "graph",
|
|
"path": "x-pack/plugins/graph/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "indexLifecycleManagement",
|
|
"path": "x-pack/plugins/index_lifecycle_management/server/services/license.ts"
|
|
},
|
|
{
|
|
"plugin": "maps",
|
|
"path": "x-pack/plugins/maps/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "painlessLab",
|
|
"path": "x-pack/plugins/painless_lab/server/services/license.ts"
|
|
},
|
|
{
|
|
"plugin": "rollup",
|
|
"path": "x-pack/plugins/rollup/server/services/license.ts"
|
|
},
|
|
{
|
|
"plugin": "searchprofiler",
|
|
"path": "x-pack/plugins/searchprofiler/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "snapshotRestore",
|
|
"path": "x-pack/plugins/snapshot_restore/server/services/license.ts"
|
|
},
|
|
{
|
|
"plugin": "transform",
|
|
"path": "x-pack/plugins/transform/server/services/license.ts"
|
|
},
|
|
{
|
|
"plugin": "upgradeAssistant",
|
|
"path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts"
|
|
},
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts"
|
|
},
|
|
{
|
|
"plugin": "upgradeAssistant",
|
|
"path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "upgradeAssistant",
|
|
"path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts"
|
|
},
|
|
{
|
|
"plugin": "actions",
|
|
"path": "x-pack/plugins/actions/server/lib/license_state.test.ts"
|
|
},
|
|
{
|
|
"plugin": "actions",
|
|
"path": "x-pack/plugins/actions/server/lib/license_state.test.ts"
|
|
},
|
|
{
|
|
"plugin": "alerting",
|
|
"path": "x-pack/plugins/alerting/server/lib/license_state.test.ts"
|
|
},
|
|
{
|
|
"plugin": "alerting",
|
|
"path": "x-pack/plugins/alerting/server/lib/license_state.test.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginSetup.refresh",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "refresh",
|
|
"description": [
|
|
"\nTriggers licensing information re-fetch."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": true,
|
|
"references": [],
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginSetup.featureUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureUsage",
|
|
"description": [
|
|
"\nAPIs to register licensed feature usage."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.FeatureUsageServiceSetup",
|
|
"text": "FeatureUsageServiceSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LicensingPluginStart",
|
|
"description": [],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.license$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license$",
|
|
"description": [
|
|
"\nSteam of licensing information {@link ILicense}."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.refresh",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"\nTriggers licensing information re-fetch."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.createLicensePoller",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createLicensePoller",
|
|
"description": [
|
|
"\nCreates a license poller to retrieve a license data with.\nAllows a plugin to configure a cluster to retrieve data from at\ngiven polling frequency."
|
|
],
|
|
"signature": [
|
|
"(clusterClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IClusterClient",
|
|
"text": "IClusterClient"
|
|
},
|
|
", pollingFrequency: number) => { license$: ",
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">; refresh(): Promise<",
|
|
"ILicense",
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.createLicensePoller.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "clusterClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IClusterClient",
|
|
"text": "IClusterClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.createLicensePoller.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "pollingFrequency",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "licensing",
|
|
"id": "def-server.LicensingPluginStart.featureUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureUsage",
|
|
"description": [
|
|
"\nAPIs to manage licensed feature usage."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.FeatureUsageServiceStart",
|
|
"text": "FeatureUsageServiceStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/licensing/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |