github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_doc_links.devdocs.json

1080 lines
No EOL
48 KiB
JSON
Raw Blame History

{
"id": "@kbn/doc-links",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.getDocLinks",
"type": "Function",
"tags": [],
"label": "getDocLinks",
"description": [],
"signature": [
"({ kibanaBranch }: ",
"GetDocLinkOptions",
") => ",
{
"pluginId": "@kbn/doc-links",
"scope": "common",
"docId": "kibKbnDocLinksPluginApi",
"section": "def-common.DocLinks",
"text": "DocLinks"
}
],
"path": "packages/kbn-doc-links/src/get_doc_links.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.getDocLinks.$1",
"type": "Object",
"tags": [],
"label": "{ kibanaBranch }",
"description": [],
"signature": [
"GetDocLinkOptions"
],
"path": "packages/kbn-doc-links/src/get_doc_links.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.getDocLinksMeta",
"type": "Function",
"tags": [],
"label": "getDocLinksMeta",
"description": [],
"signature": [
"({ kibanaBranch }: ",
"GetDocLinksMetaOptions",
") => ",
{
"pluginId": "@kbn/doc-links",
"scope": "common",
"docId": "kibKbnDocLinksPluginApi",
"section": "def-common.DocLinksMeta",
"text": "DocLinksMeta"
}
],
"path": "packages/kbn-doc-links/src/get_doc_meta.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.getDocLinksMeta.$1",
"type": "Object",
"tags": [],
"label": "{ kibanaBranch }",
"description": [],
"signature": [
"GetDocLinksMetaOptions"
],
"path": "packages/kbn-doc-links/src/get_doc_meta.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks",
"type": "Interface",
"tags": [],
"label": "DocLinks",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.settings",
"type": "string",
"tags": [],
"label": "settings",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.elasticStackGetStarted",
"type": "string",
"tags": [],
"label": "elasticStackGetStarted",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.upgrade",
"type": "Object",
"tags": [],
"label": "upgrade",
"description": [],
"signature": [
"{ readonly upgradingStackOnPrem: string; readonly upgradingStackOnCloud: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.apm",
"type": "Object",
"tags": [],
"label": "apm",
"description": [],
"signature": [
"{ readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; readonly overview: string; readonly tailSamplingPolicies: string; readonly elasticAgent: string; readonly storageExplorer: string; readonly spanCompression: string; readonly transactionSampling: string; readonly indexLifecycleManagement: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.canvas",
"type": "Object",
"tags": [],
"label": "canvas",
"description": [],
"signature": [
"{ readonly guide: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.cloud",
"type": "Object",
"tags": [],
"label": "cloud",
"description": [],
"signature": [
"{ readonly indexManagement: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.console",
"type": "Object",
"tags": [],
"label": "console",
"description": [],
"signature": [
"{ readonly guide: string; readonly serverlessGuide: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.dashboard",
"type": "Object",
"tags": [],
"label": "dashboard",
"description": [],
"signature": [
"{ readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.discover",
"type": "Object",
"tags": [],
"label": "discover",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.filebeat",
"type": "Object",
"tags": [],
"label": "filebeat",
"description": [],
"signature": [
"{ readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; readonly suricataModule: string; readonly zeekModule: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.auditbeat",
"type": "Object",
"tags": [],
"label": "auditbeat",
"description": [],
"signature": [
"{ readonly base: string; readonly auditdModule: string; readonly systemModule: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.metricbeat",
"type": "Object",
"tags": [],
"label": "metricbeat",
"description": [],
"signature": [
"{ readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.appSearch",
"type": "Object",
"tags": [],
"label": "appSearch",
"description": [],
"signature": [
"{ readonly adaptiveRelevance: string; readonly apiRef: string; readonly apiClients: string; readonly apiKeys: string; readonly authentication: string; readonly crawlRules: string; readonly curations: string; readonly duplicateDocuments: string; readonly elasticsearchIndexedEngines: string; readonly entryPoints: string; readonly gettingStarted: string; readonly guide: string; readonly indexingDocuments: string; readonly indexingDocumentsSchema: string; readonly logSettings: string; readonly metaEngines: string; readonly precisionTuning: string; readonly relevanceTuning: string; readonly resultSettings: string; readonly searchUI: string; readonly security: string; readonly synonyms: string; readonly webCrawler: string; readonly webCrawlerEventLogs: string; readonly webCrawlerReference: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.enterpriseSearch",
"type": "Object",
"tags": [],
"label": "enterpriseSearch",
"description": [],
"signature": [
"{ readonly aiSearchDoc: string; readonly aiSearchHelp: string; readonly apiKeys: string; readonly behavioralAnalytics: string; readonly behavioralAnalyticsCORS: string; readonly behavioralAnalyticsEvents: string; readonly buildConnector: string; readonly bulkApi: string; readonly configuration: string; readonly connectors: string; readonly connectorsAzureBlobStorage: string; readonly connectorsClients: string; readonly connectorsConfluence: string; readonly connectorsContentExtraction: string; readonly connectorsDropbox: string; readonly connectorsGithub: string; readonly connectorsGoogleCloudStorage: string; readonly connectorsGoogleDrive: string; readonly connectorsGmail: string; readonly connectorsJira: string; readonly connectorsMicrosoftSQL: string; readonly connectorsMongoDB: string; readonly connectorsMySQL: string; readonly connectorsNative: string; readonly connectorsNetworkDrive: string; readonly connectorsOneDrive: string; readonly connectorsOracle: string; readonly connectorsPostgreSQL: string; readonly connectorsS3: string; readonly connectorsSalesforce: string; readonly connectorsServiceNow: string; readonly connectorsSharepoint: string; readonly connectorsSharepointOnline: string; readonly connectorsSlack: string; readonly connectorsWorkplaceSearch: string; readonly crawlerExtractionRules: string; readonly crawlerManaging: string; readonly crawlerOverview: string; readonly deployTrainedModels: string; readonly documentLevelSecurity: string; readonly elser: string; readonly engines: string; readonly indexApi: string; readonly ingestionApis: string; readonly ingestPipelines: string; readonly knnSearch: string; readonly knnSearchCombine: string; readonly languageAnalyzers: string; readonly languageClients: string; readonly licenseManagement: string; readonly machineLearningStart: string; readonly mailService: string; readonly mlDocumentEnrichment: string; readonly mlDocumentEnrichmentUpdateMappings: string; readonly searchApplicationsTemplates: string; readonly searchApplicationsSearchApi: string; readonly searchApplications: string; readonly searchApplicationsSearch: string; readonly searchLabs: string; readonly searchLabsRepo: string; readonly searchTemplates: string; readonly start: string; readonly supportedNlpModels: string; readonly syncRules: string; readonly trainedModels: string; readonly textEmbedding: string; readonly troubleshootSetup: string; readonly usersAccess: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.workplaceSearch",
"type": "Object",
"tags": [],
"label": "workplaceSearch",
"description": [],
"signature": [
"{ readonly apiKeys: string; readonly box: string; readonly confluenceCloud: string; readonly confluenceCloudConnectorPackage: string; readonly confluenceServer: string; readonly contentSources: string; readonly customConnectorPackage: string; readonly customSources: string; readonly customSourcePermissions: string; readonly documentPermissions: string; readonly dropbox: string; readonly externalSharePointOnline: string; readonly externalIdentities: string; readonly gitHub: string; readonly gettingStarted: string; readonly gmail: string; readonly googleDrive: string; readonly indexingSchedule: string; readonly jiraCloud: string; readonly jiraServer: string; readonly networkDrive: string; readonly oneDrive: string; readonly permissions: string; readonly privateSourcePermissions: string; readonly salesforce: string; readonly security: string; readonly serviceNow: string; readonly sharePoint: string; readonly sharePointServer: string; readonly slack: string; readonly synch: string; readonly zendesk: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.heartbeat",
"type": "Object",
"tags": [],
"label": "heartbeat",
"description": [],
"signature": [
"{ readonly base: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.libbeat",
"type": "Object",
"tags": [],
"label": "libbeat",
"description": [],
"signature": [
"{ readonly getStarted: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.logstash",
"type": "Object",
"tags": [],
"label": "logstash",
"description": [],
"signature": [
"{ readonly base: string; readonly inputElasticAgent: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.functionbeat",
"type": "Object",
"tags": [],
"label": "functionbeat",
"description": [],
"signature": [
"{ readonly base: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.winlogbeat",
"type": "Object",
"tags": [],
"label": "winlogbeat",
"description": [],
"signature": [
"{ readonly base: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.aggs",
"type": "Object",
"tags": [],
"label": "aggs",
"description": [],
"signature": [
"{ readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly terms_doc_count_error: string; readonly rare_terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; readonly change_point: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.runtimeFields",
"type": "Object",
"tags": [],
"label": "runtimeFields",
"description": [],
"signature": [
"{ readonly overview: string; readonly mapping: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.scriptedFields",
"type": "Object",
"tags": [],
"label": "scriptedFields",
"description": [],
"signature": [
"{ readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.search",
"type": "Object",
"tags": [],
"label": "search",
"description": [],
"signature": [
"{ readonly sessions: string; readonly sessionLimits: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.indexPatterns",
"type": "Object",
"tags": [],
"label": "indexPatterns",
"description": [],
"signature": [
"{ readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; readonly runtimeFields: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.addData",
"type": "string",
"tags": [],
"label": "addData",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
"{ readonly askElastic: string; readonly createGithubIssue: string; readonly feedback: string; readonly guide: string; readonly autocompleteSuggestions: string; readonly secureSavedObject: string; readonly xpackSecurity: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.upgradeAssistant",
"type": "Object",
"tags": [],
"label": "upgradeAssistant",
"description": [],
"signature": [
"{ readonly overview: string; readonly batchReindex: string; readonly remoteReindex: string; readonly reindexWithPipeline: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.rollupJobs",
"type": "string",
"tags": [],
"label": "rollupJobs",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.elasticsearch",
"type": "Object",
"tags": [],
"label": "elasticsearch",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.siem",
"type": "Object",
"tags": [],
"label": "siem",
"description": [],
"signature": [
"{ readonly privileges: string; readonly guide: string; readonly gettingStarted: string; readonly ml: string; readonly ruleChangeLog: string; readonly detectionsReq: string; readonly networkMap: string; readonly troubleshootGaps: string; readonly ruleApiOverview: string; readonly configureAlertSuppression: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.securitySolution",
"type": "Object",
"tags": [],
"label": "securitySolution",
"description": [],
"signature": [
"{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly endpointArtifacts: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly packageActionTroubleshooting: { es_connection: string; }; readonly threatIntelInt: string; readonly responseActions: string; readonly configureEndpointIntegrationPolicy: string; readonly exceptions: { value_lists: string; }; readonly privileges: string; readonly manageDetectionRules: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ readonly eql: string; readonly kueryQuerySyntax: string; readonly luceneQuery: string; readonly luceneQuerySyntax: string; readonly percolate: string; readonly queryDsl: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.date",
"type": "Object",
"tags": [],
"label": "date",
"description": [],
"signature": [
"{ readonly dateMath: string; readonly dateMathIndexNames: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.management",
"type": "Object",
"tags": [],
"label": "management",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.ml",
"type": "Object",
"tags": [],
"label": "ml",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.transforms",
"type": "Object",
"tags": [],
"label": "transforms",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.visualize",
"type": "Object",
"tags": [],
"label": "visualize",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.apis",
"type": "Object",
"tags": [],
"label": "apis",
"description": [],
"signature": [
"{ readonly bulkIndexAlias: string; readonly indexStats: string; readonly byteSizeUnits: string; readonly createAutoFollowPattern: string; readonly createFollower: string; readonly createIndex: string; readonly createSnapshotLifecyclePolicy: string; readonly createRoleMapping: string; readonly createRoleMappingTemplates: string; readonly createRollupJobsRequest: string; readonly createApiKey: string; readonly createPipeline: string; readonly createTransformRequest: string; readonly cronExpressions: string; readonly executeWatchActionModes: string; readonly indexExists: string; readonly multiSearch: string; readonly openIndex: string; readonly putComponentTemplate: string; readonly painlessExecute: string; readonly painlessExecuteAPIContexts: string; readonly putComponentTemplateMetadata: string; readonly putSnapshotLifecyclePolicy: string; readonly putIndexTemplateV1: string; readonly putWatch: string; readonly restApis: string; readonly searchPreference: string; readonly securityApis: string; readonly simulatePipeline: string; readonly tasks: string; readonly timeUnits: string; readonly unfreezeIndex: string; readonly updateTransform: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.observability",
"type": "Object",
"tags": [],
"label": "observability",
"description": [],
"signature": [
"{ readonly guide: string; readonly infrastructureThreshold: string; readonly logsThreshold: string; readonly metricsThreshold: string; readonly threshold: string; readonly monitorStatus: string; readonly monitorUptime: string; readonly tlsCertificate: string; readonly uptimeDurationAnomaly: string; readonly monitorLogs: string; readonly analyzeMetrics: string; readonly monitorUptimeSynthetics: string; readonly userExperience: string; readonly createAlerts: string; readonly syntheticsCommandReference: string; readonly syntheticsProjectMonitors: string; readonly syntheticsMigrateFromIntegration: string; readonly sloBurnRateRule: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.alerting",
"type": "Object",
"tags": [],
"label": "alerting",
"description": [],
"signature": [
"{ readonly guide: string; readonly actionTypes: string; readonly apmRules: string; readonly emailAction: string; readonly emailActionConfig: string; readonly emailExchangeClientSecretConfig: string; readonly emailExchangeClientIdConfig: string; readonly generalSettings: string; readonly indexAction: string; readonly esQuery: string; readonly indexThreshold: string; readonly maintenanceWindows: string; readonly pagerDutyAction: string; readonly preconfiguredConnectors: string; readonly preconfiguredAlertHistoryConnector: string; readonly serviceNowAction: string; readonly serviceNowSIRAction: string; readonly setupPrerequisites: string; readonly slackAction: string; readonly slackApiAction: string; readonly teamsAction: string; readonly connectors: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.taskManager",
"type": "Object",
"tags": [],
"label": "taskManager",
"description": [],
"signature": [
"{ readonly healthMonitoring: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.maps",
"type": "Object",
"tags": [],
"label": "maps",
"description": [],
"signature": [
"{ readonly connectToEms: string; readonly guide: string; readonly importGeospatialPrivileges: string; readonly gdalTutorial: string; readonly termJoinsExample: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.monitoring",
"type": "Object",
"tags": [],
"label": "monitoring",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.reporting",
"type": "Object",
"tags": [],
"label": "reporting",
"description": [],
"signature": [
"{ readonly cloudMinimumRequirements: string; readonly grantUserAccess: string; readonly browserSystemDependencies: string; readonly browserSandboxDependencies: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
"{ readonly apiKeyServiceSettings: string; readonly clusterPrivileges: string; readonly elasticsearchSettings: string; readonly elasticsearchEnableSecurity: string; readonly elasticsearchEnableApiKeys: string; readonly indicesPrivileges: string; readonly kibanaTLS: string; readonly kibanaPrivileges: string; readonly mappingRoles: string; readonly mappingRolesFieldRules: string; readonly runAsPrivilege: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.spaces",
"type": "Object",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
"{ readonly kibanaLegacyUrlAliases: string; readonly kibanaDisableLegacyUrlAliasesApi: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.watcher",
"type": "Object",
"tags": [],
"label": "watcher",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.ccs",
"type": "Object",
"tags": [],
"label": "ccs",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.plugins",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"{ azureRepo: string; gcsRepo: string; hdfsRepo: string; ingestAttachment: string; s3Repo: string; snapshotRestoreRepos: string; mapperSize: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.snapshotRestore",
"type": "Object",
"tags": [],
"label": "snapshotRestore",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.ingest",
"type": "Object",
"tags": [],
"label": "ingest",
"description": [],
"signature": [
"{ [x: string]: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.fleet",
"type": "Object",
"tags": [],
"label": "fleet",
"description": [],
"signature": [
"{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly esSettings: string; readonly settings: string; readonly logstashSettings: string; readonly kafkaSettings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly datastreamsManualRollover: string; readonly datastreamsTSDS: string; readonly datastreamsTSDSMetrics: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; readonly api: string; readonly uninstallAgent: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.ecs",
"type": "Object",
"tags": [],
"label": "ecs",
"description": [],
"signature": [
"{ readonly guide: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.clients",
"type": "Object",
"tags": [],
"label": "clients",
"description": [],
"signature": [
"{ readonly guide: string; readonly goConnecting: string; readonly goGettingStarted: string; readonly goIndex: string; readonly goOverview: string; readonly javaBasicAuthentication: string; readonly javaIndex: string; readonly javaInstallation: string; readonly javaIntroduction: string; readonly javaRestLow: string; readonly jsAdvancedConfig: string; readonly jsApiReference: string; readonly jsBasicConfig: string; readonly jsClientConnecting: string; readonly jsIntro: string; readonly netGuide: string; readonly netIntroduction: string; readonly netNest: string; readonly netSingleNode: string; readonly phpConfiguration: string; readonly phpConnecting: string; readonly phpGuide: string; readonly phpInstallation: string; readonly phpOverview: string; readonly pythonAuthentication: string; readonly pythonConfig: string; readonly pythonConnecting: string; readonly pythonGuide: string; readonly pythonOverview: string; readonly rubyAuthentication: string; readonly rubyAdvancedConfig: string; readonly rubyBasicConfig: string; readonly rubyExamples: string; readonly rubyOverview: string; readonly rustGuide: string; readonly rustOverview: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.endpoints",
"type": "Object",
"tags": [],
"label": "endpoints",
"description": [],
"signature": [
"{ readonly troubleshooting: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.legal",
"type": "Object",
"tags": [],
"label": "legal",
"description": [],
"signature": [
"{ readonly privacyStatement: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.kibanaUpgradeSavedObjects",
"type": "Object",
"tags": [],
"label": "kibanaUpgradeSavedObjects",
"description": [],
"signature": [
"{ readonly resolveMigrationFailures: string; readonly repeatedTimeoutRequests: string; readonly routingAllocationDisabled: string; readonly clusterShardLimitExceeded: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.searchUI",
"type": "Object",
"tags": [],
"label": "searchUI",
"description": [],
"signature": [
"{ readonly appSearch: string; readonly elasticsearch: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.serverlessClients",
"type": "Object",
"tags": [],
"label": "serverlessClients",
"description": [],
"signature": [
"{ readonly goApiReference: string; readonly goGettingStarted: string; readonly httpApis: string; readonly httpApiReferences: string; readonly jsApiReference: string; readonly jsGettingStarted: string; readonly phpApiReference: string; readonly phpGettingStarted: string; readonly pythonApiReference: string; readonly pythonGettingStarted: string; readonly pythonReferences: string; readonly rubyApiReference: string; readonly rubyGettingStarted: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.serverlessSearch",
"type": "Object",
"tags": [],
"label": "serverlessSearch",
"description": [],
"signature": [
"{ readonly gettingStartedExplore: string; readonly gettingStartedIngest: string; readonly gettingStartedSearch: string; readonly integrations: string; readonly integrationsBeats: string; readonly integrationsConnectorClient: string; readonly integrationsLogstash: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.synthetics",
"type": "Object",
"tags": [],
"label": "synthetics",
"description": [],
"signature": [
"{ readonly featureRoles: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.esql",
"type": "Object",
"tags": [],
"label": "esql",
"description": [],
"signature": [
"{ readonly statsBy: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinks.telemetry",
"type": "Object",
"tags": [],
"label": "telemetry",
"description": [],
"signature": [
"{ readonly settings: string; }"
],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta",
"type": "Interface",
"tags": [],
"label": "DocLinksMeta",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta.elasticWebsiteUrl",
"type": "string",
"tags": [],
"label": "elasticWebsiteUrl",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta.elasticGithubUrl",
"type": "string",
"tags": [],
"label": "elasticGithubUrl",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta.docsWebsiteUrl",
"type": "string",
"tags": [],
"label": "docsWebsiteUrl",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/doc-links",
"id": "def-common.DocLinksMeta.searchLabsUrl",
"type": "string",
"tags": [],
"label": "searchLabsUrl",
"description": [],
"path": "packages/kbn-doc-links/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink