kibana/api_docs/search_indices.devdocs.json

287 lines
No EOL
16 KiB
JSON

{
"id": "searchIndices",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginSetup",
"type": "Interface",
"tags": [],
"label": "SearchIndicesPluginSetup",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginSetup.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginSetup.startAppId",
"type": "string",
"tags": [],
"label": "startAppId",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginSetup.startRoute",
"type": "string",
"tags": [],
"label": "startRoute",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginStart",
"type": "Interface",
"tags": [],
"label": "SearchIndicesPluginStart",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginStart.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginStart.startAppId",
"type": "CompoundType",
"tags": [],
"label": "startAppId",
"description": [],
"signature": [
"\"fleet\" | \"graph\" | \"ml\" | \"monitoring\" | \"profiling\" | \"metrics\" | \"dashboards\" | \"management\" | \"apm\" | \"synthetics\" | \"ux\" | \"canvas\" | \"logs\" | \"slo\" | \"observabilityAIAssistant\" | \"home\" | \"integrations\" | \"discover\" | \"maps\" | \"visualize\" | \"observability-overview\" | \"streams\" | \"inventory\" | \"dev_tools\" | \"dev_tools:console\" | \"dev_tools:searchprofiler\" | \"dev_tools:painless_lab\" | \"dev_tools:grokdebugger\" | \"ml:notifications\" | \"ml:nodes\" | \"ml:overview\" | \"ml:memoryUsage\" | \"ml:settings\" | \"ml:dataVisualizer\" | \"ml:logPatternAnalysis\" | \"ml:logRateAnalysis\" | \"ml:singleMetricViewer\" | \"ml:anomalyDetection\" | \"ml:anomalyExplorer\" | \"ml:dataDrift\" | \"ml:dataFrameAnalytics\" | \"ml:resultExplorer\" | \"ml:analyticsMap\" | \"ml:aiOps\" | \"ml:changePointDetections\" | \"ml:modelManagement\" | \"ml:nodesOverview\" | \"ml:esqlDataVisualizer\" | \"ml:fileUpload\" | \"ml:indexDataVisualizer\" | \"ml:calendarSettings\" | \"ml:filterListsSettings\" | \"ml:suppliedConfigurations\" | \"osquery\" | \"management:transform\" | \"management:watcher\" | \"management:tags\" | \"management:cases\" | \"management:maintenanceWindows\" | \"management:overview\" | \"management:cross_cluster_replication\" | \"management:dataViews\" | \"management:spaces\" | \"management:settings\" | \"management:analytics\" | \"management:users\" | \"management:migrate_data\" | \"management:search_sessions\" | \"management:data_quality\" | \"management:data_usage\" | \"management:filesManagement\" | \"management:trained_models\" | \"management:pipelines\" | \"management:anomaly_detection\" | \"management:roles\" | \"management:reporting\" | \"management:ad_settings\" | \"management:aiAssistantManagementSelection\" | \"management:securityAiAssistantManagement\" | \"management:observabilityAiAssistantManagement\" | \"management:api_keys\" | \"management:content_connectors\" | \"management:license_management\" | \"management:index_lifecycle_management\" | \"management:index_management\" | \"management:ingest_pipelines\" | \"management:jobsListLink\" | \"management:objects\" | \"management:remote_clusters\" | \"management:role_mappings\" | \"management:rollup_jobs\" | \"management:snapshot_restore\" | \"management:supplied_configurations\" | \"management:triggersActions\" | \"management:triggersActionsConnectors\" | \"management:upgrade_assistant\" | \"enterpriseSearch\" | \"enterpriseSearchContent\" | \"enterpriseSearchApplications\" | \"enterpriseSearchAnalytics\" | \"serverlessElasticsearch\" | \"serverlessConnectors\" | \"serverlessWebCrawlers\" | \"searchPlayground\" | \"searchInferenceEndpoints\" | \"searchSynonyms\" | \"searchQueryRules\" | \"searchHomepage\" | \"enterpriseSearchContent:connectors\" | \"enterpriseSearchContent:webCrawlers\" | \"enterpriseSearchApplications:searchApplications\" | \"searchInferenceEndpoints:inferenceEndpoints\" | \"searchSynonyms:synonyms\" | \"elasticsearchStart\" | \"elasticsearchIndices\" | \"elasticsearchIndexManagement\" | \"enterpriseSearchElasticsearch\" | \"enterpriseSearchVectorSearch\" | \"enterpriseSearchSemanticSearch\" | \"enterpriseSearchAISearch\" | \"elasticsearchIndices:createIndex\" | \"observability-logs-explorer\" | \"last-used-logs-viewer\" | \"observabilityOnboarding\" | \"logs:anomalies\" | \"logs:settings\" | \"logs:stream\" | \"logs:log-categories\" | \"observability-overview:cases\" | \"observability-overview:alerts\" | \"observability-overview:rules\" | \"observability-overview:cases_create\" | \"observability-overview:cases_configure\" | \"metrics:settings\" | \"metrics:hosts\" | \"metrics:inventory\" | \"metrics:metrics-explorer\" | \"metrics:assetDetails\" | \"apm:services\" | \"apm:traces\" | \"apm:dependencies\" | \"apm:service-map\" | \"apm:settings\" | \"apm:service-groups-list\" | \"apm:storage-explorer\" | \"synthetics:overview\" | \"synthetics:certificates\" | \"profiling:functions\" | \"profiling:stacktraces\" | \"profiling:flamegraphs\" | \"inventory:datastreams\" | \"streams:overview\" | \"securitySolutionUI\" | \"securitySolutionUI:\" | \"securitySolutionUI:cases\" | \"securitySolutionUI:alerts\" | \"securitySolutionUI:rules\" | \"securitySolutionUI:dashboards\" | \"securitySolutionUI:policy\" | \"securitySolutionUI:overview\" | \"securitySolutionUI:kubernetes\" | \"securitySolutionUI:configurations\" | \"securitySolutionUI:cases_create\" | \"securitySolutionUI:cases_configure\" | \"securitySolutionUI:hosts\" | \"securitySolutionUI:users\" | \"securitySolutionUI:cloud_security_posture-dashboard\" | \"securitySolutionUI:cloud_security_posture-vulnerability_dashboard\" | \"securitySolutionUI:cloud_security_posture-findings\" | \"securitySolutionUI:cloud_security_posture-benchmarks\" | \"securitySolutionUI:network\" | \"securitySolutionUI:data_quality\" | \"securitySolutionUI:explore\" | \"securitySolutionUI:administration\" | \"securitySolutionUI:asset_inventory\" | \"securitySolutionUI:attack_discovery\" | \"securitySolutionUI:blocklist\" | \"securitySolutionUI:cloud_security_posture-rules\" | \"securitySolutionUI:detections\" | \"securitySolutionUI:detection_response\" | \"securitySolutionUI:endpoints\" | \"securitySolutionUI:event_filters\" | \"securitySolutionUI:exceptions\" | \"securitySolutionUI:host_isolation_exceptions\" | \"securitySolutionUI:hosts-all\" | \"securitySolutionUI:hosts-anomalies\" | \"securitySolutionUI:hosts-risk\" | \"securitySolutionUI:hosts-events\" | \"securitySolutionUI:hosts-sessions\" | \"securitySolutionUI:hosts-uncommon_processes\" | \"securitySolutionUI:get_started\" | \"securitySolutionUI:network-anomalies\" | \"securitySolutionUI:network-dns\" | \"securitySolutionUI:network-events\" | \"securitySolutionUI:network-flows\" | \"securitySolutionUI:network-http\" | \"securitySolutionUI:network-tls\" | \"securitySolutionUI:response_actions_history\" | \"securitySolutionUI:rules-add\" | \"securitySolutionUI:rules-create\" | \"securitySolutionUI:rules-landing\" | \"securitySolutionUI:rules-management\" | \"securitySolutionUI:siem_migrations-rules\" | \"securitySolutionUI:threat_intelligence\" | \"securitySolutionUI:timelines\" | \"securitySolutionUI:timelines-templates\" | \"securitySolutionUI:trusted_apps\" | \"securitySolutionUI:users-all\" | \"securitySolutionUI:users-anomalies\" | \"securitySolutionUI:users-authentications\" | \"securitySolutionUI:users-events\" | \"securitySolutionUI:users-risk\" | \"securitySolutionUI:entity_analytics\" | \"securitySolutionUI:entity_analytics-management\" | \"securitySolutionUI:entity_analytics-landing\" | \"securitySolutionUI:entity_analytics-privileged_user_monitoring\" | \"securitySolutionUI:entity_analytics-entity_store_management\" | \"securitySolutionUI:coverage-overview\" | \"securitySolutionUI:notes\" | \"securitySolutionUI:alert_summary\" | \"securitySolutionUI:configurations-integrations\" | \"securitySolutionUI:configurations-ai_settings\" | \"securitySolutionUI:configurations-basic_rules\" | \"fleet:settings\" | \"fleet:agents\" | \"fleet:data_streams\" | \"fleet:policies\" | \"fleet:enrollment_tokens\" | \"fleet:uninstall_tokens\" | \"workchat\" | \"workchat:integrations\" | \"workchat:agents\""
],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "searchIndices",
"id": "def-public.SearchIndicesPluginStart.startRoute",
"type": "string",
"tags": [],
"label": "startRoute",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "searchIndices",
"id": "def-server.SearchIndicesPluginSetup",
"type": "Interface",
"tags": [],
"label": "SearchIndicesPluginSetup",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "searchIndices",
"id": "def-server.SearchIndicesPluginStart",
"type": "Interface",
"tags": [],
"label": "SearchIndicesPluginStart",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "searchIndices",
"id": "def-common.IndicesStatusResponse",
"type": "Interface",
"tags": [],
"label": "IndicesStatusResponse",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "searchIndices",
"id": "def-common.IndicesStatusResponse.indexNames",
"type": "Array",
"tags": [],
"label": "indexNames",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/solutions/search/plugins/search_indices/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "searchIndices",
"id": "def-common.UserStartPrivilegesResponse",
"type": "Interface",
"tags": [],
"label": "UserStartPrivilegesResponse",
"description": [],
"path": "x-pack/solutions/search/plugins/search_indices/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "searchIndices",
"id": "def-common.UserStartPrivilegesResponse.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
"{ canCreateApiKeys: boolean; canManageIndex: boolean; canDeleteDocuments: boolean; }"
],
"path": "x-pack/solutions/search/plugins/search_indices/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "searchIndices",
"id": "def-common.INDICES_APP_ID",
"type": "string",
"tags": [],
"label": "INDICES_APP_ID",
"description": [],
"signature": [
"\"elasticsearchIndices\""
],
"path": "x-pack/solutions/search/plugins/search_indices/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "searchIndices",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"searchIndices\""
],
"path": "x-pack/solutions/search/plugins/search_indices/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "searchIndices",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"searchIndices\""
],
"path": "x-pack/solutions/search/plugins/search_indices/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "searchIndices",
"id": "def-common.SEARCH_INDEX_MANAGEMENT_APP_ID",
"type": "string",
"tags": [],
"label": "SEARCH_INDEX_MANAGEMENT_APP_ID",
"description": [],
"signature": [
"\"elasticsearchIndexManagement\""
],
"path": "x-pack/solutions/search/plugins/search_indices/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "searchIndices",
"id": "def-common.START_APP_ID",
"type": "string",
"tags": [],
"label": "START_APP_ID",
"description": [],
"signature": [
"\"elasticsearchStart\""
],
"path": "x-pack/solutions/search/plugins/search_indices/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}