mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
1357 lines
No EOL
45 KiB
JSON
1357 lines
No EOL
45 KiB
JSON
{
|
|
"id": "cloud",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CloudConfigType",
|
|
"description": [],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.organization_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organization_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.cname",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cname",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.csp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "csp",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.base_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "base_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.profile_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "profile_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.deployments_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deployments_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.deployment_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deployment_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.projects_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "projects_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.billing_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "billing_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.organization_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organization_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.users_and_roles_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "users_and_roles_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.performance_url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "performance_url",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.trial_end_date",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "trial_end_date",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.is_elastic_staff_owned",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_elastic_staff_owned",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.onboarding",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onboarding",
|
|
"description": [],
|
|
"signature": [
|
|
"{ default_solution?: string | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudConfigType.serverless",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serverless",
|
|
"description": [],
|
|
"signature": [
|
|
"{ project_id: string; project_name?: string | undefined; project_type?: string | undefined; orchestrator_target?: string | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CloudStart",
|
|
"description": [],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.CloudContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "CloudContextProvider",
|
|
"description": [
|
|
"\nA React component that provides a pre-wired `React.Context` which connects components to Cloud services."
|
|
],
|
|
"signature": [
|
|
"React.FunctionComponent<{ children?: React.ReactNode; }>"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.CloudContextProvider.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.CloudContextProvider.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/ts5.0/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.isCloudEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCloudEnabled",
|
|
"description": [
|
|
"\n`true` when Kibana is running on Elastic Cloud."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.cloudId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nCloud ID. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.deploymentsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deploymentsUrl",
|
|
"description": [
|
|
"\nThis is the path to the Cloud deployments management page. The value is already prepended with `baseUrl`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.deploymentUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deploymentUrl",
|
|
"description": [
|
|
"\nThis is the path to the Cloud deployment management page for the deployment to which the Kibana instance belongs. The value is already prepended with `baseUrl`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.profileUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "profileUrl",
|
|
"description": [
|
|
"\nThe full URL to the user profile page on Elastic Cloud. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.billingUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "billingUrl",
|
|
"description": [
|
|
"\nThe full URL to the billing page on Elastic Cloud. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.organizationUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organizationUrl",
|
|
"description": [
|
|
"\nThe full URL to the organization management page on Elastic Cloud. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.performanceUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "performanceUrl",
|
|
"description": [
|
|
"\nThe full URL to the performance page on Elastic Cloud. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.usersAndRolesUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "usersAndRolesUrl",
|
|
"description": [
|
|
"\nThe full URL to the users and roles page on Elastic Cloud. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.projectsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "projectsUrl",
|
|
"description": [
|
|
"\nThe full URL to the serverless projects page on Elastic Cloud. Undefined if not running in Serverless."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.fetchElasticsearchConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fetchElasticsearchConfig",
|
|
"description": [
|
|
"\nFetches the full URL to the elasticsearch cluster."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"PublicElasticsearchConfigType",
|
|
">"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.kibanaUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaUrl",
|
|
"description": [
|
|
"\nThe full URL to the Kibana deployment."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.isServerlessEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isServerlessEnabled",
|
|
"description": [
|
|
"\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudStart.serverless",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serverless",
|
|
"description": [
|
|
"\nServerless configuration"
|
|
],
|
|
"signature": [
|
|
"{ projectId?: string | undefined; projectName?: string | undefined; projectType?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CloudSetup",
|
|
"description": [],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.cloudId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nCloud ID. Undefined if not running on Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.organizationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organizationId",
|
|
"description": [
|
|
"\nThe Elastic Cloud Organization that owns this deployment/project."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.deploymentId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deploymentId",
|
|
"description": [
|
|
"\nThe deployment's ID. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.cname",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cname",
|
|
"description": [
|
|
"\nThis value is the same as `baseUrl` on ESS but can be customized on ECE.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.csp",
|
|
"type": "string",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "csp",
|
|
"description": [
|
|
"\nThe cloud service provider identifier.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.baseUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseUrl",
|
|
"description": [
|
|
"\nThis is the URL of the Cloud interface."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.deploymentUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deploymentUrl",
|
|
"description": [
|
|
"\nThe full URL to the deployment management page on Elastic Cloud. Undefined if not running on Cloud.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.projectsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "projectsUrl",
|
|
"description": [
|
|
"\nThe full URL to the serverless projects page on Elastic Cloud. Undefined if not running in Serverless."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.profileUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "profileUrl",
|
|
"description": [
|
|
"\nThis is the path to the Cloud User Profile page. The value is already prepended with `baseUrl`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.organizationUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organizationUrl",
|
|
"description": [
|
|
"\nThis is the path to the Cloud Account and Billing page. The value is already prepended with `baseUrl`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.snapshotsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "snapshotsUrl",
|
|
"description": [
|
|
"\nThis is the path to the Snapshots page for the deployment to which the Kibana instance belongs. The value is already prepended with `deploymentUrl`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.fetchElasticsearchConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fetchElasticsearchConfig",
|
|
"description": [
|
|
"\nFetches the full URL to the elasticsearch cluster."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"PublicElasticsearchConfigType",
|
|
">"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.kibanaUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaUrl",
|
|
"description": [
|
|
"\nThe full URL to the Kibana deployment."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.cloudHost",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudHost",
|
|
"description": [
|
|
"\n{host} from the deployment url https://<deploymentId>.<application>.<host><?:port>"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.cloudDefaultPort",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudDefaultPort",
|
|
"description": [
|
|
"\n{port} from the deployment url https://<deploymentId>.<application>.<host><?:port>"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.isCloudEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCloudEnabled",
|
|
"description": [
|
|
"\n`true` when Kibana is running on Elastic Cloud."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.trialEndDate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "trialEndDate",
|
|
"description": [
|
|
"\nThe end date for the Elastic Cloud trial. Only available on Elastic Cloud.\n"
|
|
],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.isElasticStaffOwned",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isElasticStaffOwned",
|
|
"description": [
|
|
"\n`true` if the Elastic Cloud organization that owns this deployment is owned by an Elastician. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.registerCloudService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerCloudService",
|
|
"description": [
|
|
"\nRegisters CloudServiceProviders so start's `CloudContextProvider` hooks them.\n"
|
|
],
|
|
"signature": [
|
|
"(contextProvider: React.FC<{}>) => void"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.registerCloudService.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "contextProvider",
|
|
"description": [
|
|
"The React component from the Service Provider."
|
|
],
|
|
"signature": [
|
|
"React.FC<{}>"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.onboarding",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onboarding",
|
|
"description": [
|
|
"\nOnboarding configuration"
|
|
],
|
|
"signature": [
|
|
"{ defaultSolution?: ",
|
|
"SolutionId",
|
|
" | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.isServerlessEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isServerlessEnabled",
|
|
"description": [
|
|
"\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-public.CloudSetup.serverless",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serverless",
|
|
"description": [
|
|
"\nServerless configuration"
|
|
],
|
|
"signature": [
|
|
"{ projectId?: string | undefined; projectName?: string | undefined; projectType?: string | undefined; orchestratorTarget?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.getOnboardingToken",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOnboardingToken",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedObjectsClient: ",
|
|
"SavedObjectsClientContract",
|
|
") => Promise<string | null>"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/saved_objects/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.getOnboardingToken.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsClientContract"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/saved_objects/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CloudSetup",
|
|
"description": [
|
|
"\nSetup contract"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.cloudId",
|
|
"type": "string",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nThis is the ID of the Cloud deployment to which the Kibana instance belongs.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.csp",
|
|
"type": "string",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "csp",
|
|
"description": [
|
|
"\nThe cloud service provider identifier.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.organizationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "organizationId",
|
|
"description": [
|
|
"\nThe Elastic Cloud Organization that owns this deployment/project."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.deploymentId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deploymentId",
|
|
"description": [
|
|
"\nThe deployment's ID. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.elasticsearchUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "elasticsearchUrl",
|
|
"description": [
|
|
"\nThe full URL to the elasticsearch cluster."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.kibanaUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaUrl",
|
|
"description": [
|
|
"\nThe full URL to the Kibana deployment."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.projectsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "projectsUrl",
|
|
"description": [
|
|
"\nThis is the URL to the \"projects\" interface on cloud.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.baseUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseUrl",
|
|
"description": [
|
|
"\nThis is the URL of the Cloud interface.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.cloudHost",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudHost",
|
|
"description": [
|
|
"\n{host} of the deployment url https://<deploymentId>.<application>.<host><?:port>"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.cloudDefaultPort",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudDefaultPort",
|
|
"description": [
|
|
"\n{port} of the deployment url https://<deploymentId>.<application>.<host><?:port>"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.isCloudEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCloudEnabled",
|
|
"description": [
|
|
"\nThis is set to `true` for both ESS and ECE deployments."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.instanceSizeMb",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "instanceSizeMb",
|
|
"description": [
|
|
"\nThe size of the instance in which Kibana is running. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.trialEndDate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "trialEndDate",
|
|
"description": [
|
|
"\nWhen the Cloud Trial ends/ended for the organization that owns this deployment. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.isElasticStaffOwned",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isElasticStaffOwned",
|
|
"description": [
|
|
"\n`true` if the Elastic Cloud organization that owns this deployment is owned by an Elastician. Only available when running on Elastic Cloud."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.apm",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apm",
|
|
"description": [
|
|
"\nAPM configuration keys."
|
|
],
|
|
"signature": [
|
|
"{ url?: string | undefined; secretToken?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.onboarding",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onboarding",
|
|
"description": [
|
|
"\nOnboarding configuration."
|
|
],
|
|
"signature": [
|
|
"{ defaultSolution?: ",
|
|
"SolutionId",
|
|
" | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.isServerlessEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isServerlessEnabled",
|
|
"description": [
|
|
"\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudSetup.serverless",
|
|
"type": "Object",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "serverless",
|
|
"description": [
|
|
"\nServerless configuration.\n"
|
|
],
|
|
"signature": [
|
|
"{ projectId?: string | undefined; projectName?: string | undefined; projectType?: string | undefined; orchestratorTarget?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CloudStart",
|
|
"description": [
|
|
"\nStart contract"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudStart.isCloudEnabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCloudEnabled",
|
|
"description": [
|
|
"\nThis is set to `true` for both ESS and ECE deployments."
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudStart.projectsUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "projectsUrl",
|
|
"description": [
|
|
"\nThis is the URL to the \"projects\" interface on cloud.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "cloud",
|
|
"id": "def-server.CloudStart.baseUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseUrl",
|
|
"description": [
|
|
"\nThis is the URL of the Cloud interface.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/platform/plugins/shared/cloud/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |