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