kibana/api_docs/kbn_storage_adapter.devdocs.json

1798 lines
No EOL
88 KiB
JSON

{
"id": "@kbn/storage-adapter",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter",
"type": "Class",
"tags": [],
"label": "StorageIndexAdapter",
"description": [
"\nAdapter for writing and reading documents to/from Elasticsearch,\nusing plain indices.\n\nTODO:\n- Index Lifecycle Management\n- Schema upgrades w/ fallbacks"
],
"signature": [
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageIndexAdapter",
"text": "StorageIndexAdapter"
},
"<TStorageSettings, TApplicationType>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter.Unnamed.$3",
"type": "Uncategorized",
"tags": [],
"label": "storage",
"description": [],
"signature": [
"TStorageSettings"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageIndexAdapter.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.InternalIStorageClient",
"text": "InternalIStorageClient"
},
"<TApplicationType>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/src/index_adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.IndexStorageSettings",
"type": "Interface",
"tags": [],
"label": "IndexStorageSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.IndexStorageSettings",
"text": "IndexStorageSettings"
},
" extends StorageSettingsBase"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.IndexStorageSettings.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient",
"type": "Interface",
"tags": [],
"label": "InternalIStorageClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.InternalIStorageClient",
"text": "InternalIStorageClient"
},
"<TDocumentType>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.search",
"type": "Function",
"tags": [],
"label": "search",
"description": [],
"signature": [
"<TSearchRequest extends ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientSearchRequest",
"text": "StorageClientSearchRequest"
},
">(request: TSearchRequest) => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientSearchResponse",
"text": "StorageClientSearchResponse"
},
"<TDocumentType, TSearchRequest>>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.search.$1",
"type": "Uncategorized",
"tags": [],
"label": "request",
"description": [],
"signature": [
"TSearchRequest"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.bulk",
"type": "Function",
"tags": [],
"label": "bulk",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientBulkRequest",
"text": "StorageClientBulkRequest"
},
"<TDocumentType>) => Promise<",
"BulkResponse",
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.bulk.$1",
"type": "CompoundType",
"tags": [],
"label": "request",
"description": [],
"signature": [
"Omit<",
"BulkRequest",
"<unknown, unknown>, \"index\" | \"operations\"> & { operations: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientBulkOperation",
"text": "StorageClientBulkOperation"
},
"<TDocumentType>[]; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.index",
"type": "Function",
"tags": [],
"label": "index",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientIndexRequest",
"text": "StorageClientIndexRequest"
},
"<TDocumentType>) => Promise<",
"WriteResponseBase",
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.index.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id?: string | undefined; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; document?: Omit<TDocumentType, \"_id\"> | undefined; pipeline?: string | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; include_source_on_error?: boolean | undefined; require_alias?: boolean | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; op_type?: ",
"OpType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientDeleteRequest",
"text": "StorageClientDeleteRequest"
},
") => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientDeleteResponse",
"text": "StorageClientDeleteResponse"
},
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.delete.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id: string; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.clean",
"type": "Function",
"tags": [],
"label": "clean",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientCleanResponse",
"text": "StorageClientCleanResponse"
},
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientGetRequest",
"text": "StorageClientGetRequest"
},
") => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientGetResponse",
"text": "StorageClientGetResponse"
},
"<TDocumentType>>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.get.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id: string; sort?: ",
"Sort",
" | undefined; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; slice?: ",
"SlicedScroll",
" | undefined; version?: undefined; explain?: boolean | undefined; scroll?: ",
"Duration",
" | undefined; size?: number | undefined; fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; query?: ",
"QueryDslQueryContainer",
" | undefined; timeout?: string | undefined; allow_no_indices?: boolean | undefined; allow_partial_search_results?: boolean | undefined; analyzer?: string | undefined; analyze_wildcard?: boolean | undefined; batched_reduce_size?: number | undefined; ccs_minimize_roundtrips?: boolean | undefined; default_operator?: ",
"QueryDslOperator",
" | undefined; df?: string | undefined; expand_wildcards?: ",
"ExpandWildcards",
" | undefined; ignore_throttled?: boolean | undefined; ignore_unavailable?: boolean | undefined; include_named_queries_score?: boolean | undefined; lenient?: boolean | undefined; max_concurrent_shard_requests?: number | undefined; preference?: string | undefined; pre_filter_shard_size?: number | undefined; request_cache?: boolean | undefined; routing?: string | undefined; search_type?: ",
"SearchType",
" | undefined; suggest_field?: string | undefined; suggest_mode?: ",
"SuggestMode",
" | undefined; suggest_size?: number | undefined; suggest_text?: string | undefined; typed_keys?: boolean | undefined; rest_total_hits_as_int?: boolean | undefined; _source_excludes?: ",
"Fields",
" | undefined; _source_includes?: ",
"Fields",
" | undefined; q?: string | undefined; force_synthetic_source?: boolean | undefined; aggregations?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; collapse?: ",
"SearchFieldCollapse",
" | undefined; ext?: Record<string, any> | undefined; from?: number | undefined; highlight?: ",
"SearchHighlight",
" | undefined; track_total_hits?: ",
"SearchTrackHits",
" | undefined; indices_boost?: Record<string, number>[] | undefined; docvalue_fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; knn?: ",
"KnnSearch",
" | ",
"KnnSearch",
"[] | undefined; rank?: ",
"RankContainer",
" | undefined; min_score?: number | undefined; post_filter?: ",
"QueryDslQueryContainer",
" | undefined; profile?: boolean | undefined; rescore?: ",
"SearchRescore",
" | ",
"SearchRescore",
"[] | undefined; retriever?: ",
"RetrieverContainer",
" | undefined; script_fields?: Record<string, ",
"ScriptField",
"> | undefined; search_after?: ",
"SortResults",
" | undefined; _source?: (",
"SearchSourceConfigParam",
" & ",
"SearchSourceConfig",
") | undefined; suggest?: ",
"SearchSuggester",
" | undefined; terminate_after?: number | undefined; track_scores?: boolean | undefined; seq_no_primary_term?: boolean | undefined; stored_fields?: ",
"Fields",
" | undefined; pit?: ",
"SearchPointInTimeReference",
" | undefined; runtime_mappings?: ",
"MappingRuntimeFields",
" | undefined; stats?: string[] | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & string) | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: boolean | undefined; version_type?: ",
"VersionType",
" | undefined; realtime?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.InternalIStorageClient.existsIndex",
"type": "Function",
"tags": [],
"label": "existsIndex",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientCleanResponse",
"type": "Interface",
"tags": [],
"label": "StorageClientCleanResponse",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientCleanResponse.acknowledged",
"type": "boolean",
"tags": [],
"label": "acknowledged",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientCleanResponse.result",
"type": "CompoundType",
"tags": [],
"label": "result",
"description": [],
"signature": [
"\"deleted\" | \"noop\""
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDeleteResponse",
"type": "Interface",
"tags": [],
"label": "StorageClientDeleteResponse",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDeleteResponse.acknowledged",
"type": "boolean",
"tags": [],
"label": "acknowledged",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDeleteResponse.result",
"type": "CompoundType",
"tags": [],
"label": "result",
"description": [],
"signature": [
"\"deleted\" | \"not_found\""
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageSchema",
"type": "Interface",
"tags": [],
"label": "StorageSchema",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageSchema.properties",
"type": "Object",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"StorageSchemaProperties"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.IStorageClient",
"type": "Type",
"tags": [],
"label": "IStorageClient",
"description": [],
"signature": [
"Exact<TApplicationType, Partial<{ type: \"object\"; properties: TSchema[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TSchema[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TSchema[\"schema\"][\"properties\"])[key]> | undefined; } : object>> extends true ? ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.InternalIStorageClient",
"text": "InternalIStorageClient"
},
"<TApplicationType> : never"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.SimpleIStorageClient",
"type": "Type",
"tags": [],
"label": "SimpleIStorageClient",
"description": [],
"signature": [
"Exact<Partial<{ type: \"object\"; properties: TStorageSettings[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])[key]> | undefined; } : object>, Partial<{ type: \"object\"; properties: TStorageSettings[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])[key]> | undefined; } : object>> extends true ? ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.InternalIStorageClient",
"text": "InternalIStorageClient"
},
"<Partial<{ type: \"object\"; properties: TStorageSettings[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])[key]> | undefined; } : object>> : never"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientBulk",
"type": "Type",
"tags": [],
"label": "StorageClientBulk",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientBulkRequest",
"text": "StorageClientBulkRequest"
},
"<TDocumentType>) => Promise<",
"BulkResponse",
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientBulk.$1",
"type": "CompoundType",
"tags": [],
"label": "request",
"description": [],
"signature": [
"Omit<",
"BulkRequest",
"<unknown, unknown>, \"index\" | \"operations\"> & { operations: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientBulkOperation",
"text": "StorageClientBulkOperation"
},
"<TDocumentType>[]; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientBulkOperation",
"type": "Type",
"tags": [],
"label": "StorageClientBulkOperation",
"description": [],
"signature": [
"{ index: { document: Omit<TDocument, \"_id\">; _id?: string | undefined; }; } | { delete: { _id: string; }; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientBulkRequest",
"type": "Type",
"tags": [],
"label": "StorageClientBulkRequest",
"description": [],
"signature": [
"Omit<",
"BulkRequest",
"<unknown, unknown>, \"index\" | \"operations\"> & { operations: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientBulkOperation",
"text": "StorageClientBulkOperation"
},
"<TDocument>[]; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientBulkResponse",
"type": "Type",
"tags": [],
"label": "StorageClientBulkResponse",
"description": [],
"signature": [
"BulkResponse"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientClean",
"type": "Type",
"tags": [],
"label": "StorageClientClean",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientCleanResponse",
"text": "StorageClientCleanResponse"
},
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDelete",
"type": "Type",
"tags": [],
"label": "StorageClientDelete",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientDeleteRequest",
"text": "StorageClientDeleteRequest"
},
") => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientDeleteResponse",
"text": "StorageClientDeleteResponse"
},
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDelete.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id: string; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientDeleteRequest",
"type": "Type",
"tags": [],
"label": "StorageClientDeleteRequest",
"description": [],
"signature": [
"{ id: string; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientExistsIndex",
"type": "Type",
"tags": [],
"label": "StorageClientExistsIndex",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientGet",
"type": "Type",
"tags": [],
"label": "StorageClientGet",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientGetRequest",
"text": "StorageClientGetRequest"
},
") => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientGetResponse",
"text": "StorageClientGetResponse"
},
"<TDocumentType>>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientGet.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id: string; sort?: ",
"Sort",
" | undefined; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; slice?: ",
"SlicedScroll",
" | undefined; version?: undefined; explain?: boolean | undefined; scroll?: ",
"Duration",
" | undefined; size?: number | undefined; fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; query?: ",
"QueryDslQueryContainer",
" | undefined; timeout?: string | undefined; allow_no_indices?: boolean | undefined; allow_partial_search_results?: boolean | undefined; analyzer?: string | undefined; analyze_wildcard?: boolean | undefined; batched_reduce_size?: number | undefined; ccs_minimize_roundtrips?: boolean | undefined; default_operator?: ",
"QueryDslOperator",
" | undefined; df?: string | undefined; expand_wildcards?: ",
"ExpandWildcards",
" | undefined; ignore_throttled?: boolean | undefined; ignore_unavailable?: boolean | undefined; include_named_queries_score?: boolean | undefined; lenient?: boolean | undefined; max_concurrent_shard_requests?: number | undefined; preference?: string | undefined; pre_filter_shard_size?: number | undefined; request_cache?: boolean | undefined; routing?: string | undefined; search_type?: ",
"SearchType",
" | undefined; suggest_field?: string | undefined; suggest_mode?: ",
"SuggestMode",
" | undefined; suggest_size?: number | undefined; suggest_text?: string | undefined; typed_keys?: boolean | undefined; rest_total_hits_as_int?: boolean | undefined; _source_excludes?: ",
"Fields",
" | undefined; _source_includes?: ",
"Fields",
" | undefined; q?: string | undefined; force_synthetic_source?: boolean | undefined; aggregations?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; collapse?: ",
"SearchFieldCollapse",
" | undefined; ext?: Record<string, any> | undefined; from?: number | undefined; highlight?: ",
"SearchHighlight",
" | undefined; track_total_hits?: ",
"SearchTrackHits",
" | undefined; indices_boost?: Record<string, number>[] | undefined; docvalue_fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; knn?: ",
"KnnSearch",
" | ",
"KnnSearch",
"[] | undefined; rank?: ",
"RankContainer",
" | undefined; min_score?: number | undefined; post_filter?: ",
"QueryDslQueryContainer",
" | undefined; profile?: boolean | undefined; rescore?: ",
"SearchRescore",
" | ",
"SearchRescore",
"[] | undefined; retriever?: ",
"RetrieverContainer",
" | undefined; script_fields?: Record<string, ",
"ScriptField",
"> | undefined; search_after?: ",
"SortResults",
" | undefined; _source?: (",
"SearchSourceConfigParam",
" & ",
"SearchSourceConfig",
") | undefined; suggest?: ",
"SearchSuggester",
" | undefined; terminate_after?: number | undefined; track_scores?: boolean | undefined; seq_no_primary_term?: boolean | undefined; stored_fields?: ",
"Fields",
" | undefined; pit?: ",
"SearchPointInTimeReference",
" | undefined; runtime_mappings?: ",
"MappingRuntimeFields",
" | undefined; stats?: string[] | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & string) | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: boolean | undefined; version_type?: ",
"VersionType",
" | undefined; realtime?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientGetRequest",
"type": "Type",
"tags": [],
"label": "StorageClientGetRequest",
"description": [],
"signature": [
"{ id: string; sort?: ",
"Sort",
" | undefined; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; slice?: ",
"SlicedScroll",
" | undefined; version?: undefined; explain?: boolean | undefined; scroll?: ",
"Duration",
" | undefined; size?: number | undefined; fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; query?: ",
"QueryDslQueryContainer",
" | undefined; timeout?: string | undefined; allow_no_indices?: boolean | undefined; allow_partial_search_results?: boolean | undefined; analyzer?: string | undefined; analyze_wildcard?: boolean | undefined; batched_reduce_size?: number | undefined; ccs_minimize_roundtrips?: boolean | undefined; default_operator?: ",
"QueryDslOperator",
" | undefined; df?: string | undefined; expand_wildcards?: ",
"ExpandWildcards",
" | undefined; ignore_throttled?: boolean | undefined; ignore_unavailable?: boolean | undefined; include_named_queries_score?: boolean | undefined; lenient?: boolean | undefined; max_concurrent_shard_requests?: number | undefined; preference?: string | undefined; pre_filter_shard_size?: number | undefined; request_cache?: boolean | undefined; routing?: string | undefined; search_type?: ",
"SearchType",
" | undefined; suggest_field?: string | undefined; suggest_mode?: ",
"SuggestMode",
" | undefined; suggest_size?: number | undefined; suggest_text?: string | undefined; typed_keys?: boolean | undefined; rest_total_hits_as_int?: boolean | undefined; _source_excludes?: ",
"Fields",
" | undefined; _source_includes?: ",
"Fields",
" | undefined; q?: string | undefined; force_synthetic_source?: boolean | undefined; aggregations?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; collapse?: ",
"SearchFieldCollapse",
" | undefined; ext?: Record<string, any> | undefined; from?: number | undefined; highlight?: ",
"SearchHighlight",
" | undefined; track_total_hits?: ",
"SearchTrackHits",
" | undefined; indices_boost?: Record<string, number>[] | undefined; docvalue_fields?: (string | ",
"QueryDslFieldAndFormat",
")[] | undefined; knn?: ",
"KnnSearch",
" | ",
"KnnSearch",
"[] | undefined; rank?: ",
"RankContainer",
" | undefined; min_score?: number | undefined; post_filter?: ",
"QueryDslQueryContainer",
" | undefined; profile?: boolean | undefined; rescore?: ",
"SearchRescore",
" | ",
"SearchRescore",
"[] | undefined; retriever?: ",
"RetrieverContainer",
" | undefined; script_fields?: Record<string, ",
"ScriptField",
"> | undefined; search_after?: ",
"SortResults",
" | undefined; _source?: (",
"SearchSourceConfigParam",
" & ",
"SearchSourceConfig",
") | undefined; suggest?: ",
"SearchSuggester",
" | undefined; terminate_after?: number | undefined; track_scores?: boolean | undefined; seq_no_primary_term?: boolean | undefined; stored_fields?: ",
"Fields",
" | undefined; pit?: ",
"SearchPointInTimeReference",
" | undefined; runtime_mappings?: ",
"MappingRuntimeFields",
" | undefined; stats?: string[] | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & string) | ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; force_synthetic_source?: undefined; preference?: undefined; realtime?: undefined; refresh?: undefined; routing?: undefined; _source?: undefined; _source_excludes?: undefined; _source_includes?: undefined; stored_fields?: undefined; version?: undefined; version_type?: undefined; } & { [key: string]: any; } & { index?: undefined; allow_no_indices?: undefined; allow_partial_search_results?: undefined; analyzer?: undefined; analyze_wildcard?: undefined; batched_reduce_size?: undefined; ccs_minimize_roundtrips?: undefined; default_operator?: undefined; df?: undefined; expand_wildcards?: undefined; ignore_throttled?: undefined; ignore_unavailable?: undefined; include_named_queries_score?: undefined; lenient?: undefined; max_concurrent_shard_requests?: undefined; preference?: undefined; pre_filter_shard_size?: undefined; request_cache?: undefined; routing?: undefined; scroll?: undefined; search_type?: undefined; suggest_field?: undefined; suggest_mode?: undefined; suggest_size?: undefined; suggest_text?: undefined; typed_keys?: undefined; rest_total_hits_as_int?: undefined; _source_excludes?: undefined; _source_includes?: undefined; q?: undefined; force_synthetic_source?: undefined; aggregations?: undefined; aggs?: undefined; collapse?: undefined; explain?: undefined; ext?: undefined; from?: undefined; highlight?: undefined; track_total_hits?: undefined; indices_boost?: undefined; docvalue_fields?: undefined; knn?: undefined; rank?: undefined; min_score?: undefined; post_filter?: undefined; profile?: undefined; query?: undefined; rescore?: undefined; retriever?: undefined; script_fields?: undefined; search_after?: undefined; size?: undefined; slice?: undefined; sort?: undefined; _source?: undefined; fields?: undefined; suggest?: undefined; terminate_after?: undefined; timeout?: undefined; track_scores?: undefined; version?: undefined; seq_no_primary_term?: undefined; stored_fields?: undefined; pit?: undefined; runtime_mappings?: undefined; stats?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; refresh?: boolean | undefined; version_type?: ",
"VersionType",
" | undefined; realtime?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientGetResponse",
"type": "Type",
"tags": [],
"label": "StorageClientGetResponse",
"description": [],
"signature": [
"GetGetResult",
"<TDocument>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientIndex",
"type": "Type",
"tags": [],
"label": "StorageClientIndex",
"description": [],
"signature": [
"(request: ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientIndexRequest",
"text": "StorageClientIndexRequest"
},
"<TDocumentType>) => Promise<",
"WriteResponseBase",
">"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientIndex.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"{ id?: string | undefined; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; document?: Omit<TDocumentType, \"_id\"> | undefined; pipeline?: string | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; include_source_on_error?: boolean | undefined; require_alias?: boolean | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; op_type?: ",
"OpType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientIndexRequest",
"type": "Type",
"tags": [],
"label": "StorageClientIndexRequest",
"description": [],
"signature": [
"{ id?: string | undefined; version?: number | undefined; timeout?: ",
"Duration",
" | undefined; routing?: string | undefined; body?: string | ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; querystring?: ({ [key: string]: any; } & { id?: undefined; index?: undefined; if_primary_term?: undefined; if_seq_no?: undefined; include_source_on_error?: undefined; op_type?: undefined; pipeline?: undefined; refresh?: undefined; routing?: undefined; timeout?: undefined; version?: undefined; version_type?: undefined; wait_for_active_shards?: undefined; require_alias?: undefined; document?: undefined; }) | undefined; error_trace?: boolean | undefined; filter_path?: string | string[] | undefined; human?: boolean | undefined; pretty?: boolean | undefined; document?: Omit<TDocument, \"_id\"> | undefined; pipeline?: string | undefined; refresh?: ",
"Refresh",
" | undefined; wait_for_active_shards?: ",
"WaitForActiveShards",
" | undefined; include_source_on_error?: boolean | undefined; require_alias?: boolean | undefined; if_primary_term?: number | undefined; if_seq_no?: number | undefined; version_type?: ",
"VersionType",
" | undefined; op_type?: ",
"OpType",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientIndexResponse",
"type": "Type",
"tags": [],
"label": "StorageClientIndexResponse",
"description": [],
"signature": [
"WriteResponseBase"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientSearch",
"type": "Type",
"tags": [],
"label": "StorageClientSearch",
"description": [],
"signature": [
"<TSearchRequest extends ",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientSearchRequest",
"text": "StorageClientSearchRequest"
},
">(request: TSearchRequest) => Promise<",
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.StorageClientSearchResponse",
"text": "StorageClientSearchResponse"
},
"<TDocumentType, TSearchRequest>>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientSearch.$1",
"type": "Uncategorized",
"tags": [],
"label": "request",
"description": [],
"signature": [
"TSearchRequest"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientSearchRequest",
"type": "Type",
"tags": [],
"label": "StorageClientSearchRequest",
"description": [],
"signature": [
"Omit<",
"SearchRequest",
", \"index\"> & { track_total_hits: number | boolean; size: number; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageClientSearchResponse",
"type": "Type",
"tags": [],
"label": "StorageClientSearchResponse",
"description": [],
"signature": [
"Omit<",
"SearchResponse",
"<TDocument, Record<string, ",
"AggregationsAggregate",
">>, \"aggregations\" | \"hits\"> & (TSearchRequest extends TopLevelAggregationRequest ? WrapAggregationResponse<SubAggregateOf<TSearchRequest, TDocument>> : { aggregations?: unknown; }) & { hits: Omit<",
"SearchHitsMetadata",
"<TDocument>, \"total\" | \"hits\"> & { total: { value: number; relation: \"gte\" | \"eq\"; }; } & { hits: HitsOf<TSearchRequest, TDocument>; }; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageDocumentOf",
"type": "Type",
"tags": [],
"label": "StorageDocumentOf",
"description": [],
"signature": [
"{ [P in keyof ({ type: \"object\"; properties: TStorageSettings[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])[key]> | undefined; } : object)]?: ({ type: \"object\"; properties: TStorageSettings[\"schema\"][\"properties\"]; } extends { properties: Record<string, ",
"StorageMappingProperty",
">; } ? { [key in keyof (Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])]?: ",
"StorageFieldTypeOf",
"<(Record<string, ",
"StorageMappingProperty",
"> & TStorageSettings[\"schema\"][\"properties\"])[key]> | undefined; } : object)[P] | undefined; }"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.StorageSettings",
"type": "Type",
"tags": [],
"label": "StorageSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/storage-adapter",
"scope": "server",
"docId": "kibKbnStorageAdapterPluginApi",
"section": "def-server.IndexStorageSettings",
"text": "IndexStorageSettings"
}
],
"path": "src/platform/packages/shared/kbn-storage-adapter/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types",
"type": "Object",
"tags": [],
"label": "types",
"description": [],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.keyword",
"type": "Function",
"tags": [],
"label": "keyword",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingKeywordProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingKeywordProperty",
" & { ignore_above: 1024; } & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.keyword.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.match_only_text",
"type": "Function",
"tags": [],
"label": "match_only_text",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingMatchOnlyTextProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingMatchOnlyTextProperty",
" & Partial<",
"MappingMatchOnlyTextProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.match_only_text.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.text",
"type": "Function",
"tags": [],
"label": "text",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingTextProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingTextProperty",
" & Partial<",
"MappingTextProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.text.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.double",
"type": "Function",
"tags": [],
"label": "double",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingDoubleNumberProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingDoubleNumberProperty",
" & Partial<",
"MappingDoubleNumberProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.double.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.long",
"type": "Function",
"tags": [],
"label": "long",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingLongNumberProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingLongNumberProperty",
" & Partial<",
"MappingLongNumberProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.long.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.boolean",
"type": "Function",
"tags": [],
"label": "boolean",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingBooleanProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingBooleanProperty",
" & Partial<",
"MappingBooleanProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.boolean.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.date",
"type": "Function",
"tags": [],
"label": "date",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingDateProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingDateProperty",
" & { format: \"strict_date_optional_time\"; } & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.date.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.byte",
"type": "Function",
"tags": [],
"label": "byte",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingByteNumberProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingByteNumberProperty",
" & Partial<",
"MappingByteNumberProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.byte.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.float",
"type": "Function",
"tags": [],
"label": "float",
"description": [],
"signature": [
"<TOverrides extends Partial<",
"MappingFloatNumberProperty",
"> | undefined>(overrides?: TOverrides | undefined) => ",
"MappingFloatNumberProperty",
" & Partial<",
"MappingFloatNumberProperty",
"> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.float.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.object",
"type": "Function",
"tags": [],
"label": "object",
"description": [],
"signature": [
"<TOverrides extends Partial<StorageMappingPropertyObjectType> | undefined>(overrides?: TOverrides | undefined) => ",
"Omit",
"<",
"MappingObjectProperty",
", \"type\"> & Required<Pick<",
"MappingObjectProperty",
", \"type\">> & Partial<StorageMappingPropertyObjectType> & Exclude<TOverrides, undefined>"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/storage-adapter",
"id": "def-server.types.object.$1",
"type": "Uncategorized",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"TOverrides | undefined"
],
"path": "src/platform/packages/shared/kbn-storage-adapter/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}