kibana/api_docs/kbn_securitysolution_es_utils.devdocs.json
2022-10-20 09:44:15 -04:00

3505 lines
No EOL
138 KiB
JSON

{
"id": "@kbn/securitysolution-es-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.BadRequestError",
"type": "Class",
"tags": [],
"label": "BadRequestError",
"description": [],
"signature": [
{
"pluginId": "@kbn/securitysolution-es-utils",
"scope": "server",
"docId": "kibKbnSecuritysolutionEsUtilsPluginApi",
"section": "def-server.BadRequestError",
"text": "BadRequestError"
},
" extends Error"
],
"path": "packages/kbn-securitysolution-es-utils/src/bad_request_error/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.createBootstrapIndex",
"type": "Function",
"tags": [],
"label": "createBootstrapIndex",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", index: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.createBootstrapIndex.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.createBootstrapIndex.$2",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/create_boostrap_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.decodeVersion",
"type": "Function",
"tags": [],
"label": "decodeVersion",
"description": [],
"signature": [
"(version: string | undefined) => {} | { ifSeqNo: number; ifPrimaryTerm: number; }"
],
"path": "packages/kbn-securitysolution-es-utils/src/decode_version/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.decodeVersion.$1",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-securitysolution-es-utils/src/decode_version/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteAllIndex",
"type": "Function",
"tags": [],
"label": "deleteAllIndex",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", pattern: string, maxAttempts?: number) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteAllIndex.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteAllIndex.$2",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteAllIndex.$3",
"type": "number",
"tags": [],
"label": "maxAttempts",
"description": [],
"signature": [
"number"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteIndexTemplate",
"type": "Function",
"tags": [],
"label": "deleteIndexTemplate",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteIndexTemplate.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteIndexTemplate.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deletePolicy",
"type": "Function",
"tags": [],
"label": "deletePolicy",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deletePolicy.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deletePolicy.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteTemplate",
"type": "Function",
"tags": [],
"label": "deleteTemplate",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteTemplate.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.deleteTemplate.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/delete_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.encodeHitVersion",
"type": "Function",
"tags": [],
"label": "encodeHitVersion",
"description": [
"\nVery similar to the encode_hit_version from saved object system from here:\nsrc/core/server/saved_objects/version/encode_hit_version.ts\n\nwith the most notably change is that it doesn't do any throws but rather just returns undefined\nif _seq_no or _primary_term does not exist."
],
"signature": [
"<T>(hit: T) => string | undefined"
],
"path": "packages/kbn-securitysolution-es-utils/src/encode_hit_version/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.encodeHitVersion.$1",
"type": "Uncategorized",
"tags": [],
"label": "hit",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-securitysolution-es-utils/src/encode_hit_version/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getBootstrapIndexExists",
"type": "Function",
"tags": [],
"label": "getBootstrapIndexExists",
"description": [
"\nThis function is similar to getIndexExists, but is limited to searching indices that match\nthe index pattern used as concrete backing indices (e.g. .siem-signals-default-000001).\nThis allows us to separate the indices that are actually .siem-signals indices from\nalerts as data indices that only share the .siem-signals alias.\n"
],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", index: string) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_bootstrap_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getBootstrapIndexExists.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [
"Elasticsearch client to use to make the request"
],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_bootstrap_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getBootstrapIndexExists.$2",
"type": "string",
"tags": [],
"label": "index",
"description": [
"Index alias name to check for existence"
],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_bootstrap_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexAliases",
"type": "Function",
"tags": [],
"label": "getIndexAliases",
"description": [
"\nRetrieves all index aliases for a given alias name\n"
],
"signature": [
"({ esClient, alias, }: { esClient: ",
"ElasticsearchClient",
"; alias: string; }) => Promise<IndexAlias[]>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexAliases.$1",
"type": "Object",
"tags": [],
"label": "{\n esClient,\n alias,\n}",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexAliases.$1.esClient",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetResponse",
"<TDocument>>; }; delete: { (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; cluster: ",
"default",
"; eql: ",
"default",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; monitoring: ",
"default",
"; security: ",
"default",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; asyncSearch: ",
"default",
"; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; helpers: ",
"default",
"; autoscaling: ",
"default",
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"BulkResponse",
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"BulkResponse",
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"BulkResponse",
">; }; cat: ",
"default",
"; ccr: ",
"default",
"; clearScroll: { (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ClearScrollResponse",
">; (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ClearScrollResponse",
", unknown>>; (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ClearScrollResponse",
">; }; closePointInTime: { (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ClosePointInTimeResponse",
">; (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ClosePointInTimeResponse",
", unknown>>; (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ClosePointInTimeResponse",
">; }; count: { (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; danglingIndices: ",
"default",
"; deleteByQuery: { (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"DeleteByQueryResponse",
">; (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"DeleteByQueryResponse",
", unknown>>; (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"DeleteByQueryResponse",
">; }; deleteByQueryRethrottle: { (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TasksTaskListResponseBase",
">; (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TasksTaskListResponseBase",
", unknown>>; (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TasksTaskListResponseBase",
">; }; deleteScript: { (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"AcknowledgedResponseBase",
", unknown>>; (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; }; enrich: ",
"default",
"; exists: { (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ExplainResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ExplainResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ExplainResponse",
"<TDocument>>; }; features: ",
"default",
"; fieldCaps: { (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"FieldCapsResponse",
">; (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"FieldCapsResponse",
", unknown>>; (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"FieldCapsResponse",
">; }; fleet: ",
"default",
"; getScript: { (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptResponse",
">; (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptResponse",
", unknown>>; (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptResponse",
">; }; getScriptContext: { (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptContextResponse",
">; (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptContextResponse",
", unknown>>; (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptContextResponse",
">; }; getScriptLanguages: { (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptLanguagesResponse",
">; (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptLanguagesResponse",
", unknown>>; (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptLanguagesResponse",
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<TDocument>; }; graph: ",
"default",
"; ilm: ",
"default",
"; indices: ",
"default",
"; info: { (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"InfoResponse",
">; (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"InfoResponse",
", unknown>>; (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"InfoResponse",
">; }; ingest: ",
"default",
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"KnnSearchResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"KnnSearchResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"KnnSearchResponse",
"<TDocument>>; }; license: ",
"default",
"; logstash: ",
"default",
"; mget: { <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MgetResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MgetResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MgetResponse",
"<TDocument>>; }; migration: ",
"default",
"; ml: ",
"default",
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MsearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MsearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MsearchResponse",
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MtermvectorsResponse",
">; (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MtermvectorsResponse",
", unknown>>; (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MtermvectorsResponse",
">; }; nodes: ",
"default",
"; openPointInTime: { (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"OpenPointInTimeResponse",
">; (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"OpenPointInTimeResponse",
", unknown>>; (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"OpenPointInTimeResponse",
">; }; ping: { (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"AcknowledgedResponseBase",
", unknown>>; (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; }; rankEval: { (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"RankEvalResponse",
">; (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"RankEvalResponse",
", unknown>>; (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"RankEvalResponse",
">; }; reindex: { (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ReindexResponse",
">; (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ReindexResponse",
", unknown>>; (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ReindexResponse",
">; }; reindexRethrottle: { (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ReindexRethrottleResponse",
">; (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ReindexRethrottleResponse",
", unknown>>; (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ReindexRethrottleResponse",
">; }; renderSearchTemplate: { (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"RenderSearchTemplateResponse",
">; (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"RenderSearchTemplateResponse",
", unknown>>; (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"RenderSearchTemplateResponse",
">; }; rollup: ",
"default",
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ScriptsPainlessExecuteResponse",
"<TResult>>; <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ScriptsPainlessExecuteResponse",
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ScriptsPainlessExecuteResponse",
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ScrollResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ScrollResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ScrollResponse",
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<ArrayBuffer, unknown>>; (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchShardsResponse",
">; (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchShardsResponse",
", unknown>>; (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchShardsResponse",
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchTemplateResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchTemplateResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchTemplateResponse",
"<TDocument>>; }; searchableSnapshots: ",
"default",
"; shutdown: ",
"default",
"; slm: ",
"default",
"; snapshot: ",
"default",
"; sql: ",
"default",
"; ssl: ",
"default",
"; tasks: ",
"default",
"; termsEnum: { (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TermsEnumResponse",
">; (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TermsEnumResponse",
", unknown>>; (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TermsEnumResponse",
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TermvectorsResponse",
">; <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TermvectorsResponse",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TermvectorsResponse",
">; }; textStructure: ",
"default",
"; transform: ",
"default",
"; updateByQuery: { (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateByQueryResponse",
">; (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateByQueryResponse",
", unknown>>; (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateByQueryResponse",
">; }; updateByQueryRethrottle: { (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateByQueryRethrottleResponse",
">; (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateByQueryRethrottleResponse",
", unknown>>; (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateByQueryRethrottleResponse",
">; }; watcher: ",
"default",
"; xpack: ",
"default",
"; }"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexAliases.$1.alias",
"type": "string",
"tags": [],
"label": "alias",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_aliases/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [
"an array of {@link IndexAlias } objects"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexCount",
"type": "Function",
"tags": [],
"label": "getIndexCount",
"description": [
"\nRetrieves the count of documents in a given index\n"
],
"signature": [
"({ esClient, index, }: { esClient: ",
"ElasticsearchClient",
"; index: string; }) => Promise<number>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexCount.$1",
"type": "Object",
"tags": [],
"label": "{\n esClient,\n index,\n}",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexCount.$1.esClient",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetResponse",
"<TDocument>>; }; delete: { (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; (this: That, params: ",
"DeleteRequest",
" | ",
"DeleteRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; cluster: ",
"default",
"; eql: ",
"default",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params?: ",
"SearchRequest",
" | ",
"SearchRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; monitoring: ",
"default",
"; security: ",
"default",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; asyncSearch: ",
"default",
"; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default",
"; helpers: ",
"default",
"; autoscaling: ",
"default",
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"BulkResponse",
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"BulkResponse",
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
"BulkRequest",
"<TDocument, TPartialDocument> | ",
"BulkRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"BulkResponse",
">; }; cat: ",
"default",
"; ccr: ",
"default",
"; clearScroll: { (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ClearScrollResponse",
">; (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ClearScrollResponse",
", unknown>>; (this: That, params?: ",
"ClearScrollRequest",
" | ",
"ClearScrollRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ClearScrollResponse",
">; }; closePointInTime: { (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ClosePointInTimeResponse",
">; (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ClosePointInTimeResponse",
", unknown>>; (this: That, params: ",
"ClosePointInTimeRequest",
" | ",
"ClosePointInTimeRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ClosePointInTimeResponse",
">; }; count: { (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; danglingIndices: ",
"default",
"; deleteByQuery: { (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"DeleteByQueryResponse",
">; (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"DeleteByQueryResponse",
", unknown>>; (this: That, params: ",
"DeleteByQueryRequest",
" | ",
"DeleteByQueryRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"DeleteByQueryResponse",
">; }; deleteByQueryRethrottle: { (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TasksTaskListResponseBase",
">; (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TasksTaskListResponseBase",
", unknown>>; (this: That, params: ",
"DeleteByQueryRethrottleRequest",
" | ",
"DeleteByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TasksTaskListResponseBase",
">; }; deleteScript: { (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"AcknowledgedResponseBase",
", unknown>>; (this: That, params: ",
"DeleteScriptRequest",
" | ",
"DeleteScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; }; enrich: ",
"default",
"; exists: { (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsSourceRequest",
" | ",
"ExistsSourceRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ExplainResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ExplainResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"ExplainRequest",
" | ",
"ExplainRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ExplainResponse",
"<TDocument>>; }; features: ",
"default",
"; fieldCaps: { (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"FieldCapsResponse",
">; (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"FieldCapsResponse",
", unknown>>; (this: That, params: ",
"FieldCapsRequest",
" | ",
"FieldCapsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"FieldCapsResponse",
">; }; fleet: ",
"default",
"; getScript: { (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptResponse",
">; (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptResponse",
", unknown>>; (this: That, params: ",
"GetScriptRequest",
" | ",
"GetScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptResponse",
">; }; getScriptContext: { (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptContextResponse",
">; (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptContextResponse",
", unknown>>; (this: That, params?: ",
"GetScriptContextRequest",
" | ",
"GetScriptContextRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptContextResponse",
">; }; getScriptLanguages: { (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"GetScriptLanguagesResponse",
">; (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"GetScriptLanguagesResponse",
", unknown>>; (this: That, params?: ",
"GetScriptLanguagesRequest",
" | ",
"GetScriptLanguagesRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"GetScriptLanguagesResponse",
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
"GetSourceRequest",
" | ",
"GetSourceRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<TDocument>; }; graph: ",
"default",
"; ilm: ",
"default",
"; indices: ",
"default",
"; info: { (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"InfoResponse",
">; (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"InfoResponse",
", unknown>>; (this: That, params?: ",
"InfoRequest",
" | ",
"InfoRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"InfoResponse",
">; }; ingest: ",
"default",
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"KnnSearchResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"KnnSearchResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
"KnnSearchRequest",
" | ",
"KnnSearchRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"KnnSearchResponse",
"<TDocument>>; }; license: ",
"default",
"; logstash: ",
"default",
"; mget: { <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MgetResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MgetResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
"MgetRequest",
" | ",
"MgetRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MgetResponse",
"<TDocument>>; }; migration: ",
"default",
"; ml: ",
"default",
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MsearchResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MsearchResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchRequest",
" | ",
"MsearchRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MsearchResponse",
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"MsearchTemplateRequest",
" | ",
"MsearchTemplateRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MsearchTemplateResponse",
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"MtermvectorsResponse",
">; (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"MtermvectorsResponse",
", unknown>>; (this: That, params?: ",
"MtermvectorsRequest",
" | ",
"MtermvectorsRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"MtermvectorsResponse",
">; }; nodes: ",
"default",
"; openPointInTime: { (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"OpenPointInTimeResponse",
">; (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"OpenPointInTimeResponse",
", unknown>>; (this: That, params: ",
"OpenPointInTimeRequest",
" | ",
"OpenPointInTimeRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"OpenPointInTimeResponse",
">; }; ping: { (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"AcknowledgedResponseBase",
", unknown>>; (this: That, params: ",
"PutScriptRequest",
" | ",
"PutScriptRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"AcknowledgedResponseBase",
">; }; rankEval: { (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"RankEvalResponse",
">; (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"RankEvalResponse",
", unknown>>; (this: That, params: ",
"RankEvalRequest",
" | ",
"RankEvalRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"RankEvalResponse",
">; }; reindex: { (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ReindexResponse",
">; (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ReindexResponse",
", unknown>>; (this: That, params: ",
"ReindexRequest",
" | ",
"ReindexRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ReindexResponse",
">; }; reindexRethrottle: { (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ReindexRethrottleResponse",
">; (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ReindexRethrottleResponse",
", unknown>>; (this: That, params: ",
"ReindexRethrottleRequest",
" | ",
"ReindexRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ReindexRethrottleResponse",
">; }; renderSearchTemplate: { (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"RenderSearchTemplateResponse",
">; (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"RenderSearchTemplateResponse",
", unknown>>; (this: That, params?: ",
"RenderSearchTemplateRequest",
" | ",
"RenderSearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"RenderSearchTemplateResponse",
">; }; rollup: ",
"default",
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ScriptsPainlessExecuteResponse",
"<TResult>>; <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ScriptsPainlessExecuteResponse",
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
"ScriptsPainlessExecuteRequest",
" | ",
"ScriptsPainlessExecuteRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ScriptsPainlessExecuteResponse",
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"ScrollResponse",
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"ScrollResponse",
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
">>(this: That, params: ",
"ScrollRequest",
" | ",
"ScrollRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"ScrollResponse",
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<ArrayBuffer, unknown>>; (this: That, params: ",
"SearchMvtRequest",
" | ",
"SearchMvtRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchShardsResponse",
">; (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchShardsResponse",
", unknown>>; (this: That, params?: ",
"SearchShardsRequest",
" | ",
"SearchShardsRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchShardsResponse",
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"SearchTemplateResponse",
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"SearchTemplateResponse",
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
"SearchTemplateRequest",
" | ",
"SearchTemplateRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"SearchTemplateResponse",
"<TDocument>>; }; searchableSnapshots: ",
"default",
"; shutdown: ",
"default",
"; slm: ",
"default",
"; snapshot: ",
"default",
"; sql: ",
"default",
"; ssl: ",
"default",
"; tasks: ",
"default",
"; termsEnum: { (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TermsEnumResponse",
">; (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TermsEnumResponse",
", unknown>>; (this: That, params: ",
"TermsEnumRequest",
" | ",
"TermsEnumRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TermsEnumResponse",
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"TermvectorsResponse",
">; <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"TermvectorsResponse",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"TermvectorsRequest",
"<TDocument> | ",
"TermvectorsRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"TermvectorsResponse",
">; }; textStructure: ",
"default",
"; transform: ",
"default",
"; updateByQuery: { (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateByQueryResponse",
">; (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateByQueryResponse",
", unknown>>; (this: That, params: ",
"UpdateByQueryRequest",
" | ",
"UpdateByQueryRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateByQueryResponse",
">; }; updateByQueryRethrottle: { (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateByQueryRethrottleResponse",
">; (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateByQueryRethrottleResponse",
", unknown>>; (this: That, params: ",
"UpdateByQueryRethrottleRequest",
" | ",
"UpdateByQueryRethrottleRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateByQueryRethrottleResponse",
">; }; watcher: ",
"default",
"; xpack: ",
"default",
"; }"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexCount.$1.index",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_count/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [
"the document count"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexExists",
"type": "Function",
"tags": [],
"label": "getIndexExists",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", index: string) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexExists.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexExists.$2",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexTemplateExists",
"type": "Function",
"tags": [],
"label": "getIndexTemplateExists",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", template: string) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexTemplateExists.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getIndexTemplateExists.$2",
"type": "string",
"tags": [],
"label": "template",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getPolicyExists",
"type": "Function",
"tags": [],
"label": "getPolicyExists",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getPolicyExists.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getPolicyExists.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_policy_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getTemplateExists",
"type": "Function",
"tags": [],
"label": "getTemplateExists",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", template: string) => Promise<boolean>"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getTemplateExists.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.getTemplateExists.$2",
"type": "string",
"tags": [],
"label": "template",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/get_template_exists/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readIndex",
"type": "Function",
"tags": [],
"label": "readIndex",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", index: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readIndex.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readIndex.$2",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_index/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readPrivileges",
"type": "Function",
"tags": [],
"label": "readPrivileges",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", index: string) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readPrivileges.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.readPrivileges.$2",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/read_privileges/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setIndexTemplate",
"type": "Function",
"tags": [],
"label": "setIndexTemplate",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string, body: Record<string, unknown>) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setIndexTemplate.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setIndexTemplate.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setIndexTemplate.$3",
"type": "Object",
"tags": [],
"label": "body",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setPolicy",
"type": "Function",
"tags": [],
"label": "setPolicy",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string, body: Record<string, unknown>) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setPolicy.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setPolicy.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setPolicy.$3",
"type": "Object",
"tags": [],
"label": "body",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_policy/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setTemplate",
"type": "Function",
"tags": [],
"label": "setTemplate",
"description": [],
"signature": [
"(esClient: ",
"ElasticsearchClient",
", name: string, body: Record<string, unknown>) => Promise<unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setTemplate.$1",
"type": "Object",
"tags": [],
"label": "esClient",
"description": [],
"signature": [
"ElasticsearchClient"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setTemplate.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.setTemplate.$3",
"type": "Object",
"tags": [],
"label": "body",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "packages/kbn-securitysolution-es-utils/src/set_template/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.transformError",
"type": "Function",
"tags": [],
"label": "transformError",
"description": [],
"signature": [
"(err: Error & Partial<",
"ResponseError",
">) => ",
{
"pluginId": "@kbn/securitysolution-es-utils",
"scope": "server",
"docId": "kibKbnSecuritysolutionEsUtilsPluginApi",
"section": "def-server.OutputError",
"text": "OutputError"
}
],
"path": "packages/kbn-securitysolution-es-utils/src/transform_error/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.transformError.$1",
"type": "CompoundType",
"tags": [],
"label": "err",
"description": [],
"signature": [
"Error & Partial<",
"ResponseError",
">"
],
"path": "packages/kbn-securitysolution-es-utils/src/transform_error/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.OutputError",
"type": "Interface",
"tags": [],
"label": "OutputError",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/transform_error/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.OutputError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/transform_error/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/securitysolution-es-utils",
"id": "def-server.OutputError.statusCode",
"type": "number",
"tags": [],
"label": "statusCode",
"description": [],
"path": "packages/kbn-securitysolution-es-utils/src/transform_error/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}