Compare commits

...

13 Commits
8.12 ... v8.2.1

Author SHA1 Message Date
496161acdf Bumped v8.2.1 2022-05-25 18:17:15 +02:00
542c377459 [Backport 8.2] Changelog for 8.2.1 (#1704)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-05-25 18:16:18 +02:00
2ea3979e95 Fix node shutdown apis and code generation (#1697) 2022-05-23 16:26:11 +02:00
5603482c43 Types: move query keys to body (#1693) 2022-05-20 12:17:46 +02:00
ba2955947e Add make.sh workflows (#1696) 2022-05-20 12:07:38 +02:00
768295bdb0 Updated changelog.asciidoc (#1683) 2022-05-12 12:30:30 +02:00
b159d474b0 [Backport 8.2] Fix integration test (#1690)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-05-06 15:18:21 +02:00
bda15ca3ca Fix ndjson APIs (#1688) 2022-05-06 09:31:24 +02:00
2cc0fd4df9 API generation 2022-05-03 19:40:27 +02:00
603e4695cb [Backport 8.2] Updated dependencies (#1685)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-05-03 19:32:19 +02:00
2c6e0ddb62 API generation 2022-05-03 19:18:55 +02:00
de27dd9697 [Backport 8.2] Update TypeScript docs and export estypes (#1676)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-04-12 10:34:56 +02:00
295553c249 [Backport 8.2] Drop Node.js v12 (#1671)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-03-31 09:38:19 +02:00
27 changed files with 1403 additions and 344 deletions

View File

@ -1,4 +1,4 @@
ARG NODE_JS_VERSION=10 ARG NODE_JS_VERSION=16
FROM node:${NODE_JS_VERSION} FROM node:${NODE_JS_VERSION}
# Create app directory # Create app directory

125
.ci/make.mjs Normal file
View File

@ -0,0 +1,125 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* global $ argv */
'use strict'
import 'zx/globals'
import { readFile, writeFile } from 'fs/promises'
import assert from 'assert'
import { join } from 'desm'
import semver from 'semver'
assert(typeof argv.task === 'string', 'Missing task parameter')
switch (argv.task) {
case 'release':
release(argv._).catch(onError)
break
case 'bump':
bump(argv._).catch(onError)
break
case 'codegen':
codegen(argv._).catch(onError)
break
default:
console.log(`Unknown task: ${argv.task}`)
process.exit(1)
}
async function release (args) {
assert(args.length === 2, 'Release task expects two parameters')
let [version, outputFolder] = args
if (process.env.WORKFLOW === 'snapshot' && !version.endsWith('SNAPSHOT')) {
version = `${version}-SNAPSHOT`
}
await bump([version])
const packageJson = JSON.parse(await readFile(
join(import.meta.url, '..', 'package.json'),
'utf8'
))
await $`npm run build`
await $`npm pack`
await $`zip elasticsearch-js-${version}.zip elastic-elasticsearch-${packageJson.version}.tgz`
await $`rm elastic-elasticsearch-${packageJson.version}.tgz`
await $`mv ${join(import.meta.url, '..', `elasticsearch-js-${version}.zip`)} ${join(import.meta.url, '..', outputFolder, `elasticsearch-js-${version}.zip`)}`
}
async function bump (args) {
assert(args.length === 1, 'Bump task expects one parameter')
const [version] = args
const packageJson = JSON.parse(await readFile(
join(import.meta.url, '..', 'package.json'),
'utf8'
))
const cleanVersion = semver.clean(version.includes('SNAPSHOT') ? version.split('-')[0] : version)
assert(semver.valid(cleanVersion))
packageJson.version = cleanVersion
packageJson.versionCanary = `${cleanVersion}-canary.0`
await writeFile(
join(import.meta.url, '..', 'package.json'),
JSON.stringify(packageJson, null, 2),
'utf8'
)
const testMatrix = await readFile(join(import.meta.url, 'test-matrix.yml'), 'utf8')
await writeFile(
join(import.meta.url, 'test-matrix.yml'),
testMatrix.replace(/STACK_VERSION:\s+\- "[0-9]+[0-9\.]*[0-9](?:\-SNAPSHOT)?"/, `STACK_VERSION:\n - "${cleanVersion}-SNAPSHOT"`), // eslint-disable-line
'utf8'
)
}
// this command can only be executed locally for now
async function codegen (args) {
assert(args.length === 1, 'Bump task expects one parameter')
const clientGeneratorPath = join(import.meta.url, '..', '..', 'elastic-client-generator-js')
const [version] = args
const isGeneratorCloned = await $`[[ -d ${clientGeneratorPath} ]]`.exitCode === 0
assert(isGeneratorCloned, 'You must clone the elastic-client-generator-js first')
await $`npm install --prefix ${clientGeneratorPath}`
// this command will take a while!
if (version === 'main') {
await $`npm run elasticsearch --prefix ${clientGeneratorPath} -- --version main`
} else {
await $`npm run elasticsearch --prefix ${clientGeneratorPath} -- --version ${version.split('.').slice(0, 2).join('.')}`
}
await $`npm run lint --prefix ${clientGeneratorPath}`
await $`rm -rf ${join(import.meta.url, '..', 'src', 'api')}`
await $`mkdir ${join(import.meta.url, '..', 'src', 'api')}`
await $`cp -R ${join(import.meta.url, '..', '..', 'elastic-client-generator-js', 'output')}/* ${join(import.meta.url, '..', 'src', 'api')}`
await $`mv ${join(import.meta.url, '..', 'src', 'api', 'reference.asciidoc')} ${join(import.meta.url, '..', 'docs', 'reference.asciidoc')}`
await $`npm run build`
}
function onError (err) {
console.log(err)
process.exit(1)
}

180
.ci/make.sh Executable file
View File

@ -0,0 +1,180 @@
#!/usr/bin/env bash
# ------------------------------------------------------- #
#
# Skeleton for common build entry script for all elastic
# clients. Needs to be adapted to individual client usage.
#
# Must be called: ./.ci/make.sh <target> <params>
#
# Version: 1.1.0
#
# Targets:
# ---------------------------
# assemble <VERSION> : build client artefacts with version
# bump <VERSION> : bump client internals to version
# codegen <VERSION> : generate endpoints
# docsgen <VERSION> : generate documentation
# examplegen : generate the doc examples
# clean : clean workspace
#
# ------------------------------------------------------- #
# ------------------------------------------------------- #
# Bootstrap
# ------------------------------------------------------- #
script_path=$(dirname "$(realpath -s "$0")")
repo=$(realpath "$script_path/../")
generator=$(realpath "$script_path/../../elastic-client-generator-js")
# shellcheck disable=SC1090
CMD=$1
TASK=$1
TASK_ARGS=()
VERSION=$2
STACK_VERSION=$VERSION
NODE_JS_VERSION=16
WORKFLOW=${WORKFLOW-staging}
set -euo pipefail
product="elastic/elasticsearch-js"
output_folder=".ci/output"
OUTPUT_DIR="$repo/${output_folder}"
REPO_BINDING="${OUTPUT_DIR}:/sln/${output_folder}"
mkdir -p "$OUTPUT_DIR"
echo -e "\033[34;1mINFO:\033[0m PRODUCT ${product}\033[0m"
echo -e "\033[34;1mINFO:\033[0m VERSION ${STACK_VERSION}\033[0m"
echo -e "\033[34;1mINFO:\033[0m OUTPUT_DIR ${OUTPUT_DIR}\033[0m"
# ------------------------------------------------------- #
# Parse Command
# ------------------------------------------------------- #
case $CMD in
clean)
echo -e "\033[36;1mTARGET: clean workspace $output_folder\033[0m"
rm -rf "$output_folder"
echo -e "\033[32;1mdone.\033[0m"
exit 0
;;
assemble)
if [ -v $VERSION ]; then
echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
exit 1
fi
echo -e "\033[36;1mTARGET: assemble artefact $VERSION\033[0m"
TASK=release
TASK_ARGS=("$VERSION" "$output_folder")
;;
codegen)
if [ -v $VERSION ]; then
echo -e "\033[31;1mTARGET: codegen -> missing version parameter\033[0m"
exit 1
fi
echo -e "\033[36;1mTARGET: codegen API v$VERSION\033[0m"
TASK=codegen
# VERSION is BRANCH here for now
TASK_ARGS=("$VERSION")
;;
docsgen)
if [ -v $VERSION ]; then
echo -e "\033[31;1mTARGET: docsgen -> missing version parameter\033[0m"
exit 1
fi
echo -e "\033[36;1mTARGET: generate docs for $VERSION\033[0m"
TASK=codegen
# VERSION is BRANCH here for now
TASK_ARGS=("$VERSION" "$codegen_folder")
;;
examplesgen)
echo -e "\033[36;1mTARGET: generate examples\033[0m"
TASK=codegen
# VERSION is BRANCH here for now
TASK_ARGS=("$VERSION" "$codegen_folder")
;;
bump)
if [ -v $VERSION ]; then
echo -e "\033[31;1mTARGET: bump -> missing version parameter\033[0m"
exit 1
fi
echo -e "\033[36;1mTARGET: bump to version $VERSION\033[0m"
TASK=bump
# VERSION is BRANCH here for now
TASK_ARGS=("$VERSION")
;;
*)
echo -e "\nUsage:\n\t $CMD is not supported right now\n"
exit 1
esac
# ------------------------------------------------------- #
# Build Container
# ------------------------------------------------------- #
echo -e "\033[34;1mINFO: building $product container\033[0m"
docker build \
--file .ci/Dockerfile \
--tag ${product} \
--build-arg NODE_JS_VERSION=${NODE_JS_VERSION} \
--build-arg USER_ID="$(id -u)" \
--build-arg GROUP_ID="$(id -g)" \
.
# ------------------------------------------------------- #
# Run the Container
# ------------------------------------------------------- #
echo -e "\033[34;1mINFO: running $product container\033[0m"
docker run \
--volume $repo:/usr/src/app \
--volume $generator:/usr/src/elastic-client-generator-js \
--volume /usr/src/app/node_modules \
--env "WORKFLOW=${WORKFLOW}" \
--name make-elasticsearch-js \
--rm \
$product \
node .ci/make.mjs --task $TASK ${TASK_ARGS[*]}
# ------------------------------------------------------- #
# Post Command tasks & checks
# ------------------------------------------------------- #
if [[ "$CMD" == "assemble" ]]; then
if compgen -G ".ci/output/*" > /dev/null; then
echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
else
echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
exit 1
fi
fi
if [[ "$CMD" == "bump" ]]; then
if [ -n "$(git status --porcelain)" ]; then
echo -e "\033[32;1mTARGET: successfully bumped client v$VERSION\033[0m"
else
echo -e "\033[31;1mTARGET: failed bumped client v$VERSION\033[0m"
exit 1
fi
fi
if [[ "$CMD" == "codegen" ]]; then
if [ -n "$(git status --porcelain)" ]; then
echo -e "\033[32;1mTARGET: successfully generated client v$VERSION\033[0m"
else
echo -e "\033[31;1mTARGET: failed generating client v$VERSION\033[0m"
exit 1
fi
fi
if [[ "$CMD" == "docsgen" ]]; then
echo "TODO"
fi
if [[ "$CMD" == "examplesgen" ]]; then
echo "TODO"
fi

View File

@ -2,9 +2,9 @@
source /usr/local/bin/bash_standard_lib.sh source /usr/local/bin/bash_standard_lib.sh
DOCKER_IMAGES="node:16-alpine DOCKER_IMAGES="node:17-alpine
node:16-alpine
node:14-alpine node:14-alpine
node:12-alpine
" "
for di in ${DOCKER_IMAGES} for di in ${DOCKER_IMAGES}

View File

@ -9,7 +9,7 @@ script_path=$(dirname $(realpath -s $0))
source $script_path/functions/imports.sh source $script_path/functions/imports.sh
set -euo pipefail set -euo pipefail
NODE_JS_VERSION=${NODE_JS_VERSION-12} NODE_JS_VERSION=${NODE_JS_VERSION-16}
ELASTICSEARCH_URL=${ELASTICSEARCH_URL-"$elasticsearch_url"} ELASTICSEARCH_URL=${ELASTICSEARCH_URL-"$elasticsearch_url"}
elasticsearch_container=${elasticsearch_container-} elasticsearch_container=${elasticsearch_container-}

View File

@ -1,11 +1,11 @@
--- ---
STACK_VERSION: STACK_VERSION:
- 8.2.0-SNAPSHOT - "8.2.0-SNAPSHOT"
NODE_JS_VERSION: NODE_JS_VERSION:
- 18
- 16 - 16
- 14 - 14
- 12
TEST_SUITE: TEST_SUITE:
- free - free

View File

@ -51,5 +51,6 @@ Paste the results here:
- *node version*: 6,8,10 - *node version*: 6,8,10
- `@elastic/elasticsearch` *version*: >=7.0.0 - `@elastic/elasticsearch` *version*: >=7.0.0
- *typescript version*: 4.x (if applicable)
- *os*: Mac, Windows, Linux - *os*: Mac, Windows, Linux
- *any other relevant information* - *any other relevant information*

View File

@ -9,7 +9,7 @@ jobs:
strategy: strategy:
matrix: matrix:
node-version: [12.x, 14.x, 16.x] node-version: [14.x, 16.x, 18.x]
os: [ubuntu-latest, windows-latest, macOS-latest] os: [ubuntu-latest, windows-latest, macOS-latest]
steps: steps:
@ -176,7 +176,7 @@ jobs:
strategy: strategy:
matrix: matrix:
node-version: [14.x] node-version: [16.x]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2

View File

@ -2,7 +2,7 @@
# Elasticsearch Node.js client # Elasticsearch Node.js client
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://clients-ci.elastic.co/buildStatus/icon?job=elastic%2Belasticsearch-js%2Bmain)](https://clients-ci.elastic.co/view/Javascript/job/elastic+elasticsearch-js+main/) [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml) [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js) [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://clients-ci.elastic.co/buildStatus/icon?job=elastic%2Belasticsearch-js%2Bmain)](https://clients-ci.elastic.co/view/JavaScript/job/elastic+elasticsearch-js+main/) [![Node CI](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml) [![codecov](https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/elasticsearch-js) [![NPM downloads](https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@elastic/elasticsearch)
The official Node.js client for Elasticsearch. The official Node.js client for Elasticsearch.
@ -22,7 +22,7 @@ npm install @elastic/elasticsearch
### Node.js support ### Node.js support
NOTE: The minimum supported version of Node.js is `v12`. NOTE: The minimum supported version of Node.js is `v14`.
The client versioning follows the Elastic Stack versioning, this means that The client versioning follows the Elastic Stack versioning, this means that
major, minor, and patch releases are done following a precise schedule that major, minor, and patch releases are done following a precise schedule that
@ -44,8 +44,9 @@ of `^7.10.0`).
| Node.js Version | Node.js EOL date | End of support | | Node.js Version | Node.js EOL date | End of support |
| --------------- |------------------| ---------------------- | | --------------- |------------------| ---------------------- |
| `8.x` | `December 2019` | `7.11` (early 2021) | | `8.x` | `December 2019` | `7.11` (early 2021) |
| `10.x` | `April 2021` | `7.12` (mid 2021) | | `10.x` | `April 2021` | `7.12` (mid 2021) |
| `12.x` | `April 2022` | `8.2` (early 2022) | | `12.x` | `April 2022` | `8.2` (early 2022) |
| `14.x` | `April 2023` | `8.8` (early 2023) |
### Compatibility ### Compatibility

View File

@ -1,6 +1,84 @@
[[changelog-client]] [[changelog-client]]
== Release notes == Release notes
[discrete]
=== 8.2.1
[discrete]
==== Fixes
[discrete]
===== Support for Elasticsearch `v8.2.1`
You can find all the API changes
https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.1.html[here].
[discrete]
===== Fix ndjson APIs https://github.com/elastic/elasticsearch-js/pull/1688[#1688]
The previous release contained a bug that broken ndjson APIs.
We have released `v8.2.0-patch.1` to address this.
This fix is the same as the one we have released and we storngly recommend upgrading to this version.
[discrete]
===== Fix node shutdown apis https://github.com/elastic/elasticsearch-js/pull/1697[#1697]
The shutdown APIs wheren't complete, this fix completes them.
[discrete]
==== Types: move query keys to body https://github.com/elastic/elasticsearch-js/pull/1693[#1693]
The types definitions where wrongly representing the types of fields present in both query and body.
[discrete]
=== 8.2.0
[discrete]
==== Breaking changes
[discrete]
===== Drop Node.js v12 https://github.com/elastic/elasticsearch-js/pull/1670[#1670]
According to our https://github.com/elastic/elasticsearch-js#nodejs-support[Node.js support matrix].
[discrete]
==== Features
[discrete]
===== Support for Elasticsearch `v8.2`
You can find all the API changes
https://www.elastic.co/guide/en/elasticsearch/reference/8.2/release-notes-8.2.0.html[here].
[discrete]
===== More lenient parameter checks https://github.com/elastic/elasticsearch-js/pull/1662[#1662]
When creating a new client, an `undefined` `caFingerprint` no longer trigger an error for a http connection.
[discrete]
===== Update TypeScript docs and export estypes https://github.com/elastic/elasticsearch-js/pull/1675[#1675]
You can import the full TypeScript requests & responses definitions as it follows:
[source,ts]
----
import { estypes } from '@elastic/elasticsearch'
----
If you need the legacy definitions with the body, you can do the following:
[source,ts]
----
import { estypesWithBody } from '@elastic/elasticsearch'
----
[discrete]
==== Fixes
[discrete]
===== Updated hpagent to the latest version https://github.com/elastic/elastic-transport-js/pull/49[transport/#49]
You can fing the related changes https://github.com/delvedor/hpagent/releases/tag/v1.0.0[here].
[discrete] [discrete]
=== 8.1.0 === 8.1.0

View File

@ -24,7 +24,7 @@ To learn more about the supported major versions, please refer to the
[[nodejs-support]] [[nodejs-support]]
=== Node.js support === Node.js support
NOTE: The minimum supported version of Node.js is `v12`. NOTE: The minimum supported version of Node.js is `v14`.
The client versioning follows the {stack} versioning, this means that The client versioning follows the {stack} versioning, this means that
major, minor, and patch releases are done following a precise schedule that major, minor, and patch releases are done following a precise schedule that
@ -60,6 +60,10 @@ of `^7.10.0`).
|`12.x` |`12.x`
|April 2022 |April 2022
|`8.2` (early 2022) |`8.2` (early 2022)
|`14.x`
|April 2023
|`8.8` (early 2023)
|=== |===
[discrete] [discrete]

View File

@ -29,7 +29,7 @@
=== bulk === bulk
Allows to perform multiple index/update/delete operations in a single request. Allows to perform multiple index/update/delete operations in a single request.
https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/docs-bulk.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.bulk(...) client.bulk(...)
@ -39,7 +39,7 @@ client.bulk(...)
=== clear_scroll === clear_scroll
Explicitly clears the search context for a scroll. Explicitly clears the search context for a scroll.
https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-scroll-api.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/clear-scroll-api.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.clearScroll(...) client.clearScroll(...)
@ -49,7 +49,7 @@ client.clearScroll(...)
=== close_point_in_time === close_point_in_time
Close a point in time Close a point in time
https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/point-in-time-api.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.closePointInTime(...) client.closePointInTime(...)
@ -281,7 +281,7 @@ client.mtermvectors(...)
=== open_point_in_time === open_point_in_time
Open a point in time that can be used in subsequent searches Open a point in time that can be used in subsequent searches
https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/point-in-time-api.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.openPointInTime(...) client.openPointInTime(...)
@ -466,7 +466,7 @@ client.updateByQueryRethrottle(...)
==== delete ==== delete
Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/async-search.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.asyncSearch.delete(...) client.asyncSearch.delete(...)
@ -476,7 +476,7 @@ client.asyncSearch.delete(...)
==== get ==== get
Retrieves the results of a previously submitted async search request given its ID. Retrieves the results of a previously submitted async search request given its ID.
https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/async-search.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.asyncSearch.get(...) client.asyncSearch.get(...)
@ -486,7 +486,7 @@ client.asyncSearch.get(...)
==== status ==== status
Retrieves the status of a previously submitted async search request given its ID. Retrieves the status of a previously submitted async search request given its ID.
https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/async-search.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.asyncSearch.status(...) client.asyncSearch.status(...)
@ -496,7 +496,7 @@ client.asyncSearch.status(...)
==== submit ==== submit
Executes a search request asynchronously. Executes a search request asynchronously.
https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/async-search.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.asyncSearch.submit(...) client.asyncSearch.submit(...)
@ -508,7 +508,7 @@ client.asyncSearch.submit(...)
==== aliases ==== aliases
Shows information about currently configured aliases to indices including filter and routing infos. Shows information about currently configured aliases to indices including filter and routing infos.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-alias.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.aliases(...) client.cat.aliases(...)
@ -518,7 +518,7 @@ client.cat.aliases(...)
==== allocation ==== allocation
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-allocation.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.allocation(...) client.cat.allocation(...)
@ -536,7 +536,7 @@ client.cat.componentTemplates(...)
==== count ==== count
Provides quick access to the document count of the entire cluster, or individual indices. Provides quick access to the document count of the entire cluster, or individual indices.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-count.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.count(...) client.cat.count(...)
@ -546,7 +546,7 @@ client.cat.count(...)
==== fielddata ==== fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster. Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-fielddata.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.fielddata(...) client.cat.fielddata(...)
@ -556,7 +556,7 @@ client.cat.fielddata(...)
==== health ==== health
Returns a concise representation of the cluster health. Returns a concise representation of the cluster health.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-health.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.health(...) client.cat.health(...)
@ -566,7 +566,7 @@ client.cat.health(...)
==== help ==== help
Returns help for the Cat APIs. Returns help for the Cat APIs.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.help(...) client.cat.help(...)
@ -576,7 +576,7 @@ client.cat.help(...)
==== indices ==== indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ... Returns information about indices: number of primaries and replicas, document counts, disk size, ...
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-indices.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.indices(...) client.cat.indices(...)
@ -586,7 +586,7 @@ client.cat.indices(...)
==== master ==== master
Returns information about the master node. Returns information about the master node.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-master.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.master(...) client.cat.master(...)
@ -596,7 +596,7 @@ client.cat.master(...)
==== ml_data_frame_analytics ==== ml_data_frame_analytics
Gets configuration and usage information about data frame analytics jobs. Gets configuration and usage information about data frame analytics jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-dfanalytics.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.mlDataFrameAnalytics(...) client.cat.mlDataFrameAnalytics(...)
@ -606,7 +606,7 @@ client.cat.mlDataFrameAnalytics(...)
==== ml_datafeeds ==== ml_datafeeds
Gets configuration and usage information about datafeeds. Gets configuration and usage information about datafeeds.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-datafeeds.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.mlDatafeeds(...) client.cat.mlDatafeeds(...)
@ -616,7 +616,7 @@ client.cat.mlDatafeeds(...)
==== ml_jobs ==== ml_jobs
Gets configuration and usage information about anomaly detection jobs. Gets configuration and usage information about anomaly detection jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-anomaly-detectors.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.mlJobs(...) client.cat.mlJobs(...)
@ -626,7 +626,7 @@ client.cat.mlJobs(...)
==== ml_trained_models ==== ml_trained_models
Gets configuration and usage information about inference trained models. Gets configuration and usage information about inference trained models.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-trained-model.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.mlTrainedModels(...) client.cat.mlTrainedModels(...)
@ -636,7 +636,7 @@ client.cat.mlTrainedModels(...)
==== nodeattrs ==== nodeattrs
Returns information about custom node attributes. Returns information about custom node attributes.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-nodeattrs.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.nodeattrs(...) client.cat.nodeattrs(...)
@ -646,7 +646,7 @@ client.cat.nodeattrs(...)
==== nodes ==== nodes
Returns basic statistics about performance of cluster nodes. Returns basic statistics about performance of cluster nodes.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-nodes.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.nodes(...) client.cat.nodes(...)
@ -656,7 +656,7 @@ client.cat.nodes(...)
==== pending_tasks ==== pending_tasks
Returns a concise representation of the cluster pending tasks. Returns a concise representation of the cluster pending tasks.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-pending-tasks.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.pendingTasks(...) client.cat.pendingTasks(...)
@ -666,7 +666,7 @@ client.cat.pendingTasks(...)
==== plugins ==== plugins
Returns information about installed plugins across nodes node. Returns information about installed plugins across nodes node.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-plugins.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.plugins(...) client.cat.plugins(...)
@ -676,7 +676,7 @@ client.cat.plugins(...)
==== recovery ==== recovery
Returns information about index shard recoveries, both on-going completed. Returns information about index shard recoveries, both on-going completed.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-recovery.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.recovery(...) client.cat.recovery(...)
@ -686,7 +686,7 @@ client.cat.recovery(...)
==== repositories ==== repositories
Returns information about snapshot repositories registered in the cluster. Returns information about snapshot repositories registered in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-repositories.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.repositories(...) client.cat.repositories(...)
@ -696,7 +696,7 @@ client.cat.repositories(...)
==== segments ==== segments
Provides low-level information about the segments in the shards of an index. Provides low-level information about the segments in the shards of an index.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-segments.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.segments(...) client.cat.segments(...)
@ -706,7 +706,7 @@ client.cat.segments(...)
==== shards ==== shards
Provides a detailed view of shard allocation on nodes. Provides a detailed view of shard allocation on nodes.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-shards.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.shards(...) client.cat.shards(...)
@ -716,7 +716,7 @@ client.cat.shards(...)
==== snapshots ==== snapshots
Returns all snapshots in a specific repository. Returns all snapshots in a specific repository.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-snapshots.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.snapshots(...) client.cat.snapshots(...)
@ -726,7 +726,7 @@ client.cat.snapshots(...)
==== tasks ==== tasks
Returns information about the tasks currently executing on one or more nodes in the cluster. Returns information about the tasks currently executing on one or more nodes in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/tasks.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.tasks(...) client.cat.tasks(...)
@ -736,7 +736,7 @@ client.cat.tasks(...)
==== templates ==== templates
Returns information about existing templates. Returns information about existing templates.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-templates.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.templates(...) client.cat.templates(...)
@ -747,7 +747,7 @@ client.cat.templates(...)
Returns cluster-wide thread pool statistics per node. Returns cluster-wide thread pool statistics per node.
By default the active, queue and rejected statistics are returned for all thread pools. By default the active, queue and rejected statistics are returned for all thread pools.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-thread-pool.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.threadPool(...) client.cat.threadPool(...)
@ -757,7 +757,7 @@ client.cat.threadPool(...)
==== transforms ==== transforms
Gets configuration and usage information about transforms. Gets configuration and usage information about transforms.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cat-transforms.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cat.transforms(...) client.cat.transforms(...)
@ -769,7 +769,7 @@ client.cat.transforms(...)
==== delete_auto_follow_pattern ==== delete_auto_follow_pattern
Deletes auto-follow patterns. Deletes auto-follow patterns.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-delete-auto-follow-pattern.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-delete-auto-follow-pattern.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.deleteAutoFollowPattern(...) client.ccr.deleteAutoFollowPattern(...)
@ -779,7 +779,7 @@ client.ccr.deleteAutoFollowPattern(...)
==== follow ==== follow
Creates a new follower index configured to follow the referenced leader index. Creates a new follower index configured to follow the referenced leader index.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-put-follow.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-put-follow.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.follow(...) client.ccr.follow(...)
@ -789,7 +789,7 @@ client.ccr.follow(...)
==== follow_info ==== follow_info
Retrieves information about all follower indices, including parameters and status for each follower index Retrieves information about all follower indices, including parameters and status for each follower index
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-follow-info.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-get-follow-info.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.followInfo(...) client.ccr.followInfo(...)
@ -799,7 +799,7 @@ client.ccr.followInfo(...)
==== follow_stats ==== follow_stats
Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-follow-stats.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-get-follow-stats.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.followStats(...) client.ccr.followStats(...)
@ -809,7 +809,7 @@ client.ccr.followStats(...)
==== forget_follower ==== forget_follower
Removes the follower retention leases from the leader. Removes the follower retention leases from the leader.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-forget-follower.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-post-forget-follower.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.forgetFollower(...) client.ccr.forgetFollower(...)
@ -819,7 +819,7 @@ client.ccr.forgetFollower(...)
==== get_auto_follow_pattern ==== get_auto_follow_pattern
Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-auto-follow-pattern.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-get-auto-follow-pattern.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.getAutoFollowPattern(...) client.ccr.getAutoFollowPattern(...)
@ -829,7 +829,7 @@ client.ccr.getAutoFollowPattern(...)
==== pause_auto_follow_pattern ==== pause_auto_follow_pattern
Pauses an auto-follow pattern Pauses an auto-follow pattern
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-pause-auto-follow-pattern.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-pause-auto-follow-pattern.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.pauseAutoFollowPattern(...) client.ccr.pauseAutoFollowPattern(...)
@ -839,7 +839,7 @@ client.ccr.pauseAutoFollowPattern(...)
==== pause_follow ==== pause_follow
Pauses a follower index. The follower index will not fetch any additional operations from the leader index. Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-pause-follow.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-post-pause-follow.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.pauseFollow(...) client.ccr.pauseFollow(...)
@ -849,7 +849,7 @@ client.ccr.pauseFollow(...)
==== put_auto_follow_pattern ==== put_auto_follow_pattern
Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-put-auto-follow-pattern.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-put-auto-follow-pattern.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.putAutoFollowPattern(...) client.ccr.putAutoFollowPattern(...)
@ -859,7 +859,7 @@ client.ccr.putAutoFollowPattern(...)
==== resume_auto_follow_pattern ==== resume_auto_follow_pattern
Resumes an auto-follow pattern that has been paused Resumes an auto-follow pattern that has been paused
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-resume-auto-follow-pattern.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-resume-auto-follow-pattern.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.resumeAutoFollowPattern(...) client.ccr.resumeAutoFollowPattern(...)
@ -869,7 +869,7 @@ client.ccr.resumeAutoFollowPattern(...)
==== resume_follow ==== resume_follow
Resumes a follower index that has been paused Resumes a follower index that has been paused
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-resume-follow.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-post-resume-follow.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.resumeFollow(...) client.ccr.resumeFollow(...)
@ -879,7 +879,7 @@ client.ccr.resumeFollow(...)
==== stats ==== stats
Gets all stats related to cross-cluster replication. Gets all stats related to cross-cluster replication.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-get-stats.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-get-stats.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.stats(...) client.ccr.stats(...)
@ -889,7 +889,7 @@ client.ccr.stats(...)
==== unfollow ==== unfollow
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-post-unfollow.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ccr-post-unfollow.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ccr.unfollow(...) client.ccr.unfollow(...)
@ -901,7 +901,7 @@ client.ccr.unfollow(...)
==== allocation_explain ==== allocation_explain
Provides explanations for shard allocations in the cluster. Provides explanations for shard allocations in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-allocation-explain.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.allocationExplain(...) client.cluster.allocationExplain(...)
@ -911,7 +911,7 @@ client.cluster.allocationExplain(...)
==== delete_component_template ==== delete_component_template
Deletes a component template Deletes a component template
https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/indices-component-template.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.deleteComponentTemplate(...) client.cluster.deleteComponentTemplate(...)
@ -921,7 +921,7 @@ client.cluster.deleteComponentTemplate(...)
==== delete_voting_config_exclusions ==== delete_voting_config_exclusions
Clears cluster voting config exclusions. Clears cluster voting config exclusions.
https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/voting-config-exclusions.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.deleteVotingConfigExclusions(...) client.cluster.deleteVotingConfigExclusions(...)
@ -931,7 +931,7 @@ client.cluster.deleteVotingConfigExclusions(...)
==== exists_component_template ==== exists_component_template
Returns information about whether a particular component template exist Returns information about whether a particular component template exist
https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/indices-component-template.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.existsComponentTemplate(...) client.cluster.existsComponentTemplate(...)
@ -941,7 +941,7 @@ client.cluster.existsComponentTemplate(...)
==== get_component_template ==== get_component_template
Returns one or more component templates Returns one or more component templates
https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/indices-component-template.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.getComponentTemplate(...) client.cluster.getComponentTemplate(...)
@ -951,7 +951,7 @@ client.cluster.getComponentTemplate(...)
==== get_settings ==== get_settings
Returns cluster settings. Returns cluster settings.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-get-settings.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-get-settings.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.getSettings(...) client.cluster.getSettings(...)
@ -961,7 +961,7 @@ client.cluster.getSettings(...)
==== health ==== health
Returns basic information about the health of the cluster. Returns basic information about the health of the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-health.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.health(...) client.cluster.health(...)
@ -972,7 +972,7 @@ client.cluster.health(...)
Returns a list of any cluster-level changes (e.g. create index, update mapping, Returns a list of any cluster-level changes (e.g. create index, update mapping,
allocate or fail shard) which have not yet been executed. allocate or fail shard) which have not yet been executed.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-pending.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.pendingTasks(...) client.cluster.pendingTasks(...)
@ -982,7 +982,7 @@ client.cluster.pendingTasks(...)
==== post_voting_config_exclusions ==== post_voting_config_exclusions
Updates the cluster voting config exclusions by node ids or node names. Updates the cluster voting config exclusions by node ids or node names.
https://www.elastic.co/guide/en/elasticsearch/reference/master/voting-config-exclusions.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/voting-config-exclusions.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.postVotingConfigExclusions(...) client.cluster.postVotingConfigExclusions(...)
@ -992,7 +992,7 @@ client.cluster.postVotingConfigExclusions(...)
==== put_component_template ==== put_component_template
Creates or updates a component template Creates or updates a component template
https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-component-template.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/indices-component-template.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.putComponentTemplate(...) client.cluster.putComponentTemplate(...)
@ -1002,7 +1002,7 @@ client.cluster.putComponentTemplate(...)
==== put_settings ==== put_settings
Updates the cluster settings. Updates the cluster settings.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-update-settings.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.putSettings(...) client.cluster.putSettings(...)
@ -1012,7 +1012,7 @@ client.cluster.putSettings(...)
==== remote_info ==== remote_info
Returns the information about configured remote clusters. Returns the information about configured remote clusters.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-remote-info.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.remoteInfo(...) client.cluster.remoteInfo(...)
@ -1022,7 +1022,7 @@ client.cluster.remoteInfo(...)
==== reroute ==== reroute
Allows to manually change the allocation of individual shards in the cluster. Allows to manually change the allocation of individual shards in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-reroute.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.reroute(...) client.cluster.reroute(...)
@ -1032,7 +1032,7 @@ client.cluster.reroute(...)
==== state ==== state
Returns a comprehensive information about the state of the cluster. Returns a comprehensive information about the state of the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-state.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.state(...) client.cluster.state(...)
@ -1042,7 +1042,7 @@ client.cluster.state(...)
==== stats ==== stats
Returns high-level overview of cluster statistics. Returns high-level overview of cluster statistics.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-stats.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.stats(...) client.cluster.stats(...)
@ -2085,7 +2085,7 @@ client.migration.postFeatureUpgrade(...)
==== close_job ==== close_job
Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-close-job.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ml-close-job.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.closeJob(...) client.ml.closeJob(...)
@ -2095,7 +2095,7 @@ client.ml.closeJob(...)
==== delete_calendar ==== delete_calendar
Deletes a calendar. Deletes a calendar.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-delete-calendar.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ml-delete-calendar.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.deleteCalendar(...) client.ml.deleteCalendar(...)
@ -2105,7 +2105,7 @@ client.ml.deleteCalendar(...)
==== delete_calendar_event ==== delete_calendar_event
Deletes scheduled events from a calendar. Deletes scheduled events from a calendar.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-delete-calendar-event.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ml-delete-calendar-event.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.deleteCalendarEvent(...) client.ml.deleteCalendarEvent(...)
@ -2115,7 +2115,7 @@ client.ml.deleteCalendarEvent(...)
==== delete_calendar_job ==== delete_calendar_job
Deletes anomaly detection jobs from a calendar. Deletes anomaly detection jobs from a calendar.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-delete-calendar-job.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ml-delete-calendar-job.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.deleteCalendarJob(...) client.ml.deleteCalendarJob(...)
@ -2125,7 +2125,7 @@ client.ml.deleteCalendarJob(...)
==== delete_data_frame_analytics ==== delete_data_frame_analytics
Deletes an existing data frame analytics job. Deletes an existing data frame analytics job.
https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-dfanalytics.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/delete-dfanalytics.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.deleteDataFrameAnalytics(...) client.ml.deleteDataFrameAnalytics(...)
@ -2135,7 +2135,7 @@ client.ml.deleteDataFrameAnalytics(...)
==== delete_datafeed ==== delete_datafeed
Deletes an existing datafeed. Deletes an existing datafeed.
https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-delete-datafeed.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/ml-delete-datafeed.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.deleteDatafeed(...) client.ml.deleteDatafeed(...)
@ -2384,6 +2384,8 @@ client.ml.getJobs(...)
[discrete] [discrete]
==== get_memory_stats ==== get_memory_stats
Returns information on how ML is using memory. Returns information on how ML is using memory.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.getMemoryStats(...) client.ml.getMemoryStats(...)
@ -2543,7 +2545,7 @@ client.ml.putCalendarJob(...)
==== put_data_frame_analytics ==== put_data_frame_analytics
Instantiates a data frame analytics job. Instantiates a data frame analytics job.
https://www.elastic.co/guide/en/elasticsearch/reference/master/put-dfanalytics.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/put-dfanalytics.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.putDataFrameAnalytics(...) client.ml.putDataFrameAnalytics(...)
@ -2795,7 +2797,7 @@ client.nodes.getRepositoriesMeteringInfo(...)
==== hot_threads ==== hot_threads
Returns information about hot threads on each node in the cluster. Returns information about hot threads on each node in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-nodes-hot-threads.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.nodes.hotThreads(...) client.nodes.hotThreads(...)
@ -2805,7 +2807,7 @@ client.nodes.hotThreads(...)
==== info ==== info
Returns information about nodes in the cluster. Returns information about nodes in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-nodes-info.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.nodes.info(...) client.nodes.info(...)
@ -2825,7 +2827,7 @@ client.nodes.reloadSecureSettings(...)
==== stats ==== stats
Returns statistical information about nodes in the cluster. Returns statistical information about nodes in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-nodes-stats.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.nodes.stats(...) client.nodes.stats(...)
@ -2835,7 +2837,7 @@ client.nodes.stats(...)
==== usage ==== usage
Returns low-level information about REST actions usage on nodes. Returns low-level information about REST actions usage on nodes.
https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/cluster-nodes-usage.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.nodes.usage(...) client.nodes.usage(...)
@ -2980,6 +2982,8 @@ client.searchableSnapshots.stats(...)
[discrete] [discrete]
==== activate_user_profile ==== activate_user_profile
Creates or updates the user profile on behalf of another user. Creates or updates the user profile on behalf of another user.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.security.activateUserProfile(...) client.security.activateUserProfile(...)
@ -3288,6 +3292,8 @@ client.security.getUserPrivileges(...)
[discrete] [discrete]
==== get_user_profile ==== get_user_profile
Retrieves user profile for the given unique ID. Retrieves user profile for the given unique ID.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.security.getUserProfile(...) client.security.getUserProfile(...)
@ -3474,18 +3480,20 @@ client.security.samlServiceProviderMetadata(...)
---- ----
[discrete] [discrete]
==== search_user_profiles ==== suggest_user_profiles
Searches for user profiles that match specified criteria. Get suggestions for user profiles that match specified search criteria.
https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-search-user-profile.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.security.searchUserProfiles(...) client.security.suggestUserProfiles(...)
---- ----
[discrete] [discrete]
==== update_user_profile_data ==== update_user_profile_data
Update application specific data for the user profile of the given unique ID. Update application specific data for the user profile of the given unique ID.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.security.updateUserProfileData(...) client.security.updateUserProfileData(...)
@ -3785,7 +3793,7 @@ client.ssl.certificates(...)
==== cancel ==== cancel
Cancels a task, if it can be cancelled through an API. Cancels a task, if it can be cancelled through an API.
https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/tasks.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.tasks.cancel(...) client.tasks.cancel(...)
@ -3795,7 +3803,7 @@ client.tasks.cancel(...)
==== get ==== get
Returns information about a task. Returns information about a task.
https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/tasks.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.tasks.get(...) client.tasks.get(...)
@ -3805,7 +3813,7 @@ client.tasks.get(...)
==== list ==== list
Returns a list of tasks. Returns a list of tasks.
https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[Endpoint documentation] https://www.elastic.co/guide/en/elasticsearch/reference/8.2/tasks.html[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.tasks.list(...) client.tasks.list(...)

View File

@ -7,6 +7,10 @@ of type definitions of Elasticsearch's API surface.
The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL), The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL),
and others may contain some errors, but we are continuously pushing fixes & improvements. and others may contain some errors, but we are continuously pushing fixes & improvements.
NOTE: The client is developed against the https://www.npmjs.com/package/typescript?activeTab=versions[latest]
version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`,
you should configure `esModuleInterop` to `true`.
[discrete] [discrete]
==== Example ==== Example
@ -77,3 +81,10 @@ You can import the full TypeScript requests & responses definitions as it follow
---- ----
import { estypes } from '@elastic/elasticsearch' import { estypes } from '@elastic/elasticsearch'
---- ----
If you need the legacy definitions with the body, you can do the following:
[source,ts]
----
import { estypesWithBody } from '@elastic/elasticsearch'
----

2
index.d.ts vendored
View File

@ -21,5 +21,7 @@ import Client from './lib/client'
import SniffingTransport from './lib/sniffingTransport' import SniffingTransport from './lib/sniffingTransport'
export * from '@elastic/transport' export * from '@elastic/transport'
export * as estypes from './lib/api/types'
export * as estypesWithBody from './lib/api/types'
export { Client, SniffingTransport } export { Client, SniffingTransport }
export type { ClientOptions, NodeOptions } from './lib/client' export type { ClientOptions, NodeOptions } from './lib/client'

View File

@ -1,7 +1,7 @@
{ {
"name": "@elastic/elasticsearch", "name": "@elastic/elasticsearch",
"version": "8.2.0", "version": "8.2.1",
"versionCanary": "8.2.0-canary.2", "versionCanary": "8.2.1-canary.0",
"description": "The official Elasticsearch client for Node.js", "description": "The official Elasticsearch client for Node.js",
"main": "index.js", "main": "index.js",
"types": "index.d.ts", "types": "index.d.ts",
@ -45,43 +45,44 @@
}, },
"homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html", "homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
"engines": { "engines": {
"node": ">=12" "node": ">=14"
}, },
"devDependencies": { "devDependencies": {
"@sinonjs/fake-timers": "github:sinonjs/fake-timers#0bfffc1", "@sinonjs/fake-timers": "github:sinonjs/fake-timers#0bfffc1",
"@types/debug": "^4.1.6", "@types/debug": "^4.1.7",
"@types/ms": "^0.7.31", "@types/ms": "^0.7.31",
"@types/node": "^16.4.1", "@types/node": "^17.0.31",
"@types/sinonjs__fake-timers": "^6.0.3", "@types/sinonjs__fake-timers": "^8.1.2",
"@types/split2": "^3.2.1", "@types/split2": "^3.2.1",
"@types/stoppable": "^1.1.1", "@types/stoppable": "^1.1.1",
"@types/tap": "^15.0.5", "@types/tap": "^15.0.7",
"cross-zip": "^4.0.0", "cross-zip": "^4.0.0",
"desm": "^1.2.0",
"fast-deep-equal": "^3.1.3", "fast-deep-equal": "^3.1.3",
"into-stream": "^6.0.0", "into-stream": "^7.0.0",
"js-yaml": "^4.1.0", "js-yaml": "^4.1.0",
"license-checker": "^25.0.1", "license-checker": "^25.0.1",
"minimist": "^1.2.5", "minimist": "^1.2.6",
"ms": "^2.1.3", "ms": "^2.1.3",
"node-abort-controller": "^2.0.0", "node-abort-controller": "^3.0.1",
"node-fetch": "^2.6.2", "node-fetch": "^2.6.7",
"ora": "^5.4.1", "ora": "^5.4.1",
"proxy": "^1.0.2", "proxy": "^1.0.2",
"rimraf": "^3.0.2", "rimraf": "^3.0.2",
"semver": "^7.3.5", "semver": "^7.3.7",
"split2": "^3.2.2", "split2": "^4.1.0",
"standard": "^16.0.3",
"stoppable": "^1.1.0", "stoppable": "^1.1.0",
"tap": "^15.0.9", "tap": "^16.1.0",
"ts-node": "^10.1.0", "ts-node": "^10.7.0",
"ts-standard": "^10.0.0", "ts-standard": "^11.0.0",
"typescript": "^4.3.5", "typescript": "^4.6.4",
"workq": "^3.0.0", "workq": "^3.0.0",
"xmlbuilder2": "^3.0.2" "xmlbuilder2": "^3.0.2",
"zx": "^6.1.0"
}, },
"dependencies": { "dependencies": {
"@elastic/transport": "^8.0.2", "@elastic/transport": "^8.2.0",
"tslib": "^2.3.0" "tslib": "^2.4.0"
}, },
"tap": { "tap": {
"ts": true, "ts": true,

View File

@ -91,7 +91,7 @@ export default class Internal {
async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async health (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = [] const acceptedPath: string[] = ['component', 'feature']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined

View File

@ -65,10 +65,10 @@ export default class AsyncSearch {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async get<TDocument = unknown> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchGetResponse<TDocument>> async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchGetResponse<TDocument, TAggregations>>
async get<TDocument = unknown> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchGetResponse<TDocument>, unknown>> async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchGetResponse<TDocument, TAggregations>, unknown>>
async get<TDocument = unknown> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptions): Promise<T.AsyncSearchGetResponse<TDocument>> async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptions): Promise<T.AsyncSearchGetResponse<TDocument, TAggregations>>
async get<TDocument = unknown> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptions): Promise<any> { async get<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params: T.AsyncSearchGetRequest | TB.AsyncSearchGetRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id'] const acceptedPath: string[] = ['id']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined
@ -109,10 +109,10 @@ export default class AsyncSearch {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async submit<TDocument = unknown> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchSubmitResponse<TDocument>> async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.AsyncSearchSubmitResponse<TDocument, TAggregations>>
async submit<TDocument = unknown> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchSubmitResponse<TDocument>, unknown>> async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.AsyncSearchSubmitResponse<TDocument, TAggregations>, unknown>>
async submit<TDocument = unknown> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptions): Promise<T.AsyncSearchSubmitResponse<TDocument>> async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptions): Promise<T.AsyncSearchSubmitResponse<TDocument, TAggregations>>
async submit<TDocument = unknown> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptions): Promise<any> { async submit<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.AsyncSearchSubmitRequest | TB.AsyncSearchSubmitRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['index'] const acceptedPath: string[] = ['index']
const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats'] const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}

View File

@ -103,10 +103,10 @@ export default class Cat {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async componentTemplates (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CatComponentTemplatesResponse>
async componentTemplates (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CatComponentTemplatesResponse, unknown>>
async componentTemplates (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise<T.CatComponentTemplatesResponse>
async componentTemplates (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async componentTemplates (this: That, params?: T.CatComponentTemplatesRequest | TB.CatComponentTemplatesRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['name'] const acceptedPath: string[] = ['name']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined
@ -116,6 +116,7 @@ export default class Cat {
if (acceptedPath.includes(key)) { if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }

View File

@ -860,19 +860,31 @@ export default class Indices {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesModifyDataStreamResponse>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesModifyDataStreamResponse, unknown>>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptions): Promise<T.IndicesModifyDataStreamResponse>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = [] const acceptedPath: string[] = []
const acceptedBody: string[] = ['actions']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined // @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }

View File

@ -1163,7 +1163,7 @@ export default class Ml {
async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlInferTrainedModelDeploymentResponse> async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlInferTrainedModelDeploymentResponse>
async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<any> { async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['model_id'] const acceptedPath: string[] = ['model_id']
const acceptedBody: string[] = ['docs'] const acceptedBody: string[] = ['docs', 'inference_config']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
// @ts-expect-error // @ts-expect-error
const userBody: any = params?.body const userBody: any = params?.body

View File

@ -43,19 +43,31 @@ export default class Security {
this.transport = transport this.transport = transport
} }
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = [] const acceptedPath: string[] = []
const acceptedBody: string[] = ['access_token', 'grant_type', 'password', 'username']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined // @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }
@ -436,19 +448,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid'] const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }
@ -480,19 +492,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid'] const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }
@ -830,19 +842,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid'] const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined const body = undefined
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }
@ -1421,41 +1433,66 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = [] const acceptedPath: string[] = []
const acceptedBody: string[] = ['name', 'size']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined // @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
params = params ?? {} params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }
const method = body != null ? 'POST' : 'GET' const method = body != null ? 'POST' : 'GET'
const path = '/_security/profile/_search' const path = '/_security/profile/_suggest'
return await this.transport.request({ path, method, querystring, body }, options) return await this.transport.request({ path, method, querystring, body }, options)
} }
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO> async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>> async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO> async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateUserProfileDataResponse>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> { async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid'] const acceptedPath: string[] = ['uid']
const acceptedBody: string[] = ['access', 'data']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined // @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
params = params ?? {}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key] querystring[key] = params[key]
} }
} }

View File

@ -100,11 +100,23 @@ export default class Shutdown {
async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptions): Promise<T.ShutdownPutNodeResponse> async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptions): Promise<T.ShutdownPutNodeResponse>
async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptions): Promise<any> { async putNode (this: That, params: T.ShutdownPutNodeRequest | TB.ShutdownPutNodeRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['node_id'] const acceptedPath: string[] = ['node_id']
const acceptedBody: string[] = ['type', 'reason', 'allocation_delay', 'target_node_name']
const querystring: Record<string, any> = {} const querystring: Record<string, any> = {}
const body = undefined // @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
for (const key in params) { for (const key in params) {
if (acceptedPath.includes(key)) { if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue continue
} else if (key !== 'body') { } else if (key !== 'body') {
// @ts-expect-error // @ts-expect-error

View File

@ -241,7 +241,7 @@ export interface DeleteByQueryRethrottleRequest extends RequestBase {
requests_per_second?: long requests_per_second?: long
} }
export type DeleteByQueryRethrottleResponse = TasksListResponse export type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
export interface DeleteScriptRequest extends RequestBase { export interface DeleteScriptRequest extends RequestBase {
id: Id id: Id
@ -556,10 +556,21 @@ export interface MsearchMultisearchBody {
aggregations?: Record<string, AggregationsAggregationContainer> aggregations?: Record<string, AggregationsAggregationContainer>
aggs?: Record<string, AggregationsAggregationContainer> aggs?: Record<string, AggregationsAggregationContainer>
query?: QueryDslQueryContainer query?: QueryDslQueryContainer
explain?: boolean
stored_fields?: Fields
docvalue_fields?: (QueryDslFieldAndFormat | Field)[]
from?: integer from?: integer
size?: integer size?: integer
pit?: SearchPointInTimeReference sort?: Sort
_source?: SearchSourceConfig
terminate_after?: long
stats?: string[]
timeout?: string
track_scores?: boolean
track_total_hits?: SearchTrackHits track_total_hits?: SearchTrackHits
version?: boolean
seq_no_primary_term?: boolean
pit?: SearchPointInTimeReference
suggest?: SearchSuggester suggest?: SearchSuggester
} }
@ -572,6 +583,9 @@ export interface MsearchMultisearchHeader {
request_cache?: boolean request_cache?: boolean
routing?: string routing?: string
search_type?: SearchType search_type?: SearchType
ccs_minimize_roundtrips?: boolean
allow_partial_search_results?: boolean
ignore_throttled?: boolean
} }
export interface MsearchRequest extends RequestBase { export interface MsearchRequest extends RequestBase {
@ -1088,12 +1102,13 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
collate_match?: boolean collate_match?: boolean
contexts?: Record<string, SearchContext[]> contexts?: Record<string, SearchContext[]>
fields?: Record<string, any> fields?: Record<string, any>
_id: string _id?: string
_index: IndexName _index?: IndexName
_routing?: Routing _routing?: Routing
_score?: double _score?: double
_source?: TDocument _source?: TDocument
text: string text: string
score?: double
} }
export interface SearchCompletionSuggester extends SearchSuggesterBase { export interface SearchCompletionSuggester extends SearchSuggesterBase {
@ -1153,9 +1168,9 @@ export interface SearchFieldCollapse {
export interface SearchFieldSuggester { export interface SearchFieldSuggester {
completion?: SearchCompletionSuggester completion?: SearchCompletionSuggester
phrase?: SearchPhraseSuggester phrase?: SearchPhraseSuggester
term?: SearchTermSuggester
prefix?: string prefix?: string
regex?: string regex?: string
term?: SearchTermSuggester
text?: string text?: string
} }
@ -2516,6 +2531,7 @@ export interface AggregationsAggregationContainer {
geohash_grid?: AggregationsGeoHashGridAggregation geohash_grid?: AggregationsGeoHashGridAggregation
geo_line?: AggregationsGeoLineAggregation geo_line?: AggregationsGeoLineAggregation
geotile_grid?: AggregationsGeoTileGridAggregation geotile_grid?: AggregationsGeoTileGridAggregation
geohex_grid?: AggregationsGeohexGridAggregation
global?: AggregationsGlobalAggregation global?: AggregationsGlobalAggregation
histogram?: AggregationsHistogramAggregation histogram?: AggregationsHistogramAggregation
ip_range?: AggregationsIpRangeAggregation ip_range?: AggregationsIpRangeAggregation
@ -2713,14 +2729,6 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre
type?: RelationName type?: RelationName
} }
export interface AggregationsClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> { export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> {
after_key?: Record<string, any> after_key?: Record<string, any>
} }
@ -2989,6 +2997,14 @@ export interface AggregationsGeoTileGridBucketKeys extends AggregationsMultiBuck
export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys
& { [property: string]: AggregationsAggregate | GeoTile | long } & { [property: string]: AggregationsAggregate | GeoTile | long }
export interface AggregationsGeohexGridAggregation extends AggregationsBucketAggregationBase {
field: Field
precision?: integer
bounds?: GeoBounds
size?: integer
shard_size?: integer
}
export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase { export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase {
} }
export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys
@ -3086,8 +3102,8 @@ export interface AggregationsInferenceClassImportance {
} }
export interface AggregationsInferenceConfigContainer { export interface AggregationsInferenceConfigContainer {
regression?: AggregationsRegressionInferenceOptions regression?: MlRegressionInferenceOptions
classification?: AggregationsClassificationInferenceOptions classification?: MlClassificationInferenceOptions
} }
export interface AggregationsInferenceFeatureImportance { export interface AggregationsInferenceFeatureImportance {
@ -3377,11 +3393,6 @@ export interface AggregationsRateAggregation extends AggregationsFormatMetricAgg
export type AggregationsRateMode = 'sum' | 'value_count' export type AggregationsRateMode = 'sum' | 'value_count'
export interface AggregationsRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase { export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase {
} }
export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys
@ -3448,7 +3459,8 @@ export interface AggregationsSignificantTermsAggregation extends AggregationsBuc
execution_hint?: AggregationsTermsAggregationExecutionHint execution_hint?: AggregationsTermsAggregationExecutionHint
field?: Field field?: Field
gnd?: AggregationsGoogleNormalizedDistanceHeuristic gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[] include?: AggregationsTermsInclude
jlh?: EmptyObject
min_doc_count?: long min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic percentage?: AggregationsPercentageScoreHeuristic
@ -3472,6 +3484,7 @@ export interface AggregationsSignificantTextAggregation extends AggregationsBuck
filter_duplicate_text?: boolean filter_duplicate_text?: boolean
gnd?: AggregationsGoogleNormalizedDistanceHeuristic gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[] include?: string | string[]
jlh?: EmptyObject
min_doc_count?: long min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic percentage?: AggregationsPercentageScoreHeuristic
@ -4477,7 +4490,7 @@ export interface MappingDenseVectorProperty extends MappingPropertyBase {
index_options?: MappingDenseVectorIndexOptions index_options?: MappingDenseVectorIndexOptions
} }
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
doc_values?: boolean doc_values?: boolean
@ -4542,21 +4555,6 @@ export interface MappingFloatRangeProperty extends MappingRangePropertyBase {
type: 'float_range' type: 'float_range'
} }
export interface MappingGenericProperty extends MappingDocValuesPropertyBase {
analyzer: string
boost: double
fielddata: IndicesStringFielddata
ignore_malformed: boolean
index: boolean
index_options: MappingIndexOptions
norms: boolean
null_value: string
position_increment_gap: integer
search_analyzer: string
term_vector: MappingTermVectorOption
type: string
}
export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw' export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'
export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase { export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
@ -4692,7 +4690,6 @@ export type MappingProperty = MappingFlattenedProperty | MappingJoinProperty | M
export interface MappingPropertyBase { export interface MappingPropertyBase {
local_metadata?: Metadata local_metadata?: Metadata
meta?: Record<string, string> meta?: Record<string, string>
name?: PropertyName
properties?: Record<PropertyName, MappingProperty> properties?: Record<PropertyName, MappingProperty>
ignore_above?: integer ignore_above?: integer
dynamic?: MappingDynamicMapping dynamic?: MappingDynamicMapping
@ -4901,7 +4898,7 @@ export interface QueryDslConstantScoreQuery extends QueryDslQueryBase {
export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode }
export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> { export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> {
} }
@ -4919,7 +4916,7 @@ export interface QueryDslDateRangeQuery extends QueryDslRangeQueryBase {
export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction
export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase { export interface QueryDslDecayFunctionBase {
multi_value_mode?: QueryDslMultiValueMode multi_value_mode?: QueryDslMultiValueMode
} }
@ -4962,7 +4959,7 @@ export interface QueryDslFieldLookup {
export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal' export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'
export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslFieldValueFactorScoreFunction {
field: Field field: Field
factor?: double factor?: double
missing?: double missing?: double
@ -5013,7 +5010,7 @@ export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys
export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode }
export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> { export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> {
} }
@ -5279,7 +5276,7 @@ export interface QueryDslNumberRangeQuery extends QueryDslRangeQueryBase {
export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode }
export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR' export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'
@ -5409,7 +5406,7 @@ export interface QueryDslQueryStringQuery extends QueryDslQueryBase {
type?: QueryDslTextQueryType type?: QueryDslTextQueryType
} }
export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslRandomScoreFunction {
field?: Field field?: Field
seed?: long | string seed?: long | string
} }
@ -5457,16 +5454,11 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
value: string value: string
} }
export interface QueryDslScoreFunctionBase {
filter?: QueryDslQueryContainer
weight?: double
}
export interface QueryDslScriptQuery extends QueryDslQueryBase { export interface QueryDslScriptQuery extends QueryDslQueryBase {
script: Script script: Script
} }
export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslScriptScoreFunction {
script: Script script: Script
} }
@ -5655,8 +5647,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
wait_for_completion_timeout?: Time wait_for_completion_timeout?: Time
} }
export interface AsyncSearchGetResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> { export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
}
export interface AsyncSearchStatusRequest extends RequestBase { export interface AsyncSearchStatusRequest extends RequestBase {
id: Id id: Id
@ -5736,8 +5727,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
runtime_mappings?: MappingRuntimeFields runtime_mappings?: MappingRuntimeFields
} }
export interface AsyncSearchSubmitResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> { export type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
}
export interface AutoscalingAutoscalingPolicy { export interface AutoscalingAutoscalingPolicy {
roles: string[] roles: string[]
@ -5879,6 +5869,22 @@ export interface CatAllocationRequest extends CatCatRequestBase {
export type CatAllocationResponse = CatAllocationAllocationRecord[] export type CatAllocationResponse = CatAllocationAllocationRecord[]
export interface CatComponentTemplatesComponentTemplate {
name: string
version: string
alias_count: string
mapping_count: string
settings_count: string
metadata_count: string
included_in: string
}
export interface CatComponentTemplatesRequest extends CatCatRequestBase {
name?: string
}
export type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
export interface CatCountCountRecord { export interface CatCountCountRecord {
epoch?: EpochMillis epoch?: EpochMillis
t?: EpochMillis t?: EpochMillis
@ -8610,8 +8616,7 @@ export interface EqlGetRequest extends RequestBase {
wait_for_completion_timeout?: Time wait_for_completion_timeout?: Time
} }
export interface EqlGetResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> { export type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
}
export interface EqlGetStatusRequest extends RequestBase { export interface EqlGetStatusRequest extends RequestBase {
id: Id id: Id
@ -8647,8 +8652,7 @@ export interface EqlSearchRequest extends RequestBase {
runtime_mappings?: MappingRuntimeFields runtime_mappings?: MappingRuntimeFields
} }
export interface EqlSearchResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> { export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
}
export type EqlSearchResultPosition = 'tail' | 'head' export type EqlSearchResultPosition = 'tail' | 'head'
@ -9087,7 +9091,7 @@ export interface IndicesFielddataFrequencyFilter {
min_segment_size: integer min_segment_size: integer
} }
export type IndicesIndexCheckOnStartup = boolean | 'false' | 'checksum' | 'true' export type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum'
export interface IndicesIndexRouting { export interface IndicesIndexRouting {
allocation?: IndicesIndexRoutingAllocation allocation?: IndicesIndexRoutingAllocation
@ -9273,6 +9277,7 @@ export interface IndicesMappingLimitSettings {
nested_objects?: IndicesMappingLimitSettingsNestedObjects nested_objects?: IndicesMappingLimitSettingsNestedObjects
field_name_length?: IndicesMappingLimitSettingsFieldNameLength field_name_length?: IndicesMappingLimitSettingsFieldNameLength
dimension_fields?: IndicesMappingLimitSettingsDimensionFields dimension_fields?: IndicesMappingLimitSettingsDimensionFields
ignore_malformed?: boolean
} }
export interface IndicesMappingLimitSettingsDepth { export interface IndicesMappingLimitSettingsDepth {
@ -9430,13 +9435,7 @@ export interface IndicesStorage {
allow_mmap?: boolean allow_mmap?: boolean
} }
export type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs' export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesStringFielddata {
format: IndicesStringFielddataFormat
}
export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled'
export interface IndicesTemplateMapping { export interface IndicesTemplateMapping {
aliases: Record<IndexName, IndicesAlias> aliases: Record<IndexName, IndicesAlias>
@ -9454,7 +9453,7 @@ export interface IndicesTranslog {
retention?: IndicesTranslogRetention retention?: IndicesTranslogRetention
} }
export type IndicesTranslogDurability = 'request' | 'async' export type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'
export interface IndicesTranslogRetention { export interface IndicesTranslogRetention {
size?: ByteSize size?: ByteSize
@ -9615,7 +9614,7 @@ export interface IndicesCreateRequest extends RequestBase {
export interface IndicesCreateResponse { export interface IndicesCreateResponse {
index: IndexName index: IndexName
shards_acknowledged: boolean shards_acknowledged: boolean
acknowledged?: boolean acknowledged: boolean
} }
export interface IndicesCreateDataStreamRequest extends RequestBase { export interface IndicesCreateDataStreamRequest extends RequestBase {
@ -9941,6 +9940,22 @@ export interface IndicesMigrateToDataStreamRequest extends RequestBase {
export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase
export interface IndicesModifyDataStreamAction {
add_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
remove_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
}
export interface IndicesModifyDataStreamIndexAndDataStreamAction {
index: IndexName
data_stream: DataStreamName
}
export interface IndicesModifyDataStreamRequest extends RequestBase {
actions: IndicesModifyDataStreamAction[]
}
export type IndicesModifyDataStreamResponse = AcknowledgedResponseBase
export interface IndicesOpenRequest extends RequestBase { export interface IndicesOpenRequest extends RequestBase {
index: Indices index: Indices
allow_no_indices?: boolean allow_no_indices?: boolean
@ -10761,10 +10776,20 @@ export interface IngestGsubProcessor extends IngestProcessorBase {
export interface IngestInferenceConfig { export interface IngestInferenceConfig {
regression?: IngestInferenceConfigRegression regression?: IngestInferenceConfigRegression
classification?: IngestInferenceConfigClassification
}
export interface IngestInferenceConfigClassification {
num_top_classes?: integer
num_top_feature_importance_values?: integer
results_field?: Field
top_classes_results_field?: Field
prediction_field_type?: string
} }
export interface IngestInferenceConfigRegression { export interface IngestInferenceConfigRegression {
results_field: string results_field?: Field
num_top_feature_importance_values?: integer
} }
export interface IngestInferenceProcessor extends IngestProcessorBase { export interface IngestInferenceProcessor extends IngestProcessorBase {
@ -11381,6 +11406,14 @@ export interface MlChunkingConfig {
export type MlChunkingMode = 'auto' | 'manual' | 'off' export type MlChunkingMode = 'auto' | 'manual' | 'off'
export interface MlClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte' export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'
export type MlCustomSettings = any export type MlCustomSettings = any
@ -11771,6 +11804,18 @@ export interface MlDiscoveryNode {
export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over' export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'
export interface MlFillMaskInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlFillMaskInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlFilter { export interface MlFilter {
description?: string description?: string
filter_id: Id filter_id: Id
@ -11811,6 +11856,17 @@ export interface MlHyperparameters {
export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance'
export interface MlInferenceConfigCreateContainer {
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
}
export interface MlInfluence { export interface MlInfluence {
influencer_field_name: string influencer_field_name: string
influencer_field_values: string[] influencer_field_values: string[]
@ -11970,6 +12026,47 @@ export interface MlModelSnapshot {
timestamp: long timestamp: long
} }
export interface MlNerInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlNerInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlNlpBertTokenizationConfig {
do_lower_case?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpInferenceConfigUpdateContainer {
text_classification?: MlTextClassificationInferenceUpdateOptions
zero_shot_classification?: MlZeroShotClassificationInferenceUpdateOptions
fill_mask?: MlFillMaskInferenceUpdateOptions
ner?: MlNerInferenceUpdateOptions
pass_through?: MlPassThroughInferenceUpdateOptions
text_embedding?: MlTextEmbeddingInferenceUpdateOptions
}
export interface MlNlpRobertaTokenizationConfig {
add_prefix_space?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpTokenizationUpdateOptions {
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlOutlierDetectionParameters { export interface MlOutlierDetectionParameters {
compute_feature_influence?: boolean compute_feature_influence?: boolean
feature_influence_threshold?: double feature_influence_threshold?: double
@ -11998,6 +12095,16 @@ export interface MlPage {
size?: integer size?: integer
} }
export interface MlPassThroughInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlPassThroughInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlPerPartitionCategorization { export interface MlPerPartitionCategorization {
enabled?: boolean enabled?: boolean
stop_on_warn?: boolean stop_on_warn?: boolean
@ -12005,6 +12112,11 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = string | double export type MlPredictedValue = string | double
export interface MlRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping' export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'
export type MlRuleAction = 'skip_result' | 'skip_model_update' export type MlRuleAction = 'skip_result' | 'skip_model_update'
@ -12020,11 +12132,43 @@ export interface MlRunningStateSearchInterval {
start_ms: long start_ms: long
} }
export interface MlTextClassificationInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlTextClassificationInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
classification_labels?: string[]
}
export interface MlTextEmbeddingInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlTextEmbeddingInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlTimingStats { export interface MlTimingStats {
elapsed_time: integer elapsed_time: integer
iteration_time?: integer iteration_time?: integer
} }
export interface MlTokenizationConfigContainer {
bert?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
export interface MlTopClassEntry { export interface MlTopClassEntry {
class_name: string class_name: string
class_probability: double class_probability: double
@ -12077,7 +12221,7 @@ export interface MlTrainedModelConfig {
description?: string description?: string
estimated_heap_memory_usage_bytes?: integer estimated_heap_memory_usage_bytes?: integer
estimated_operations?: integer estimated_operations?: integer
inference_config: AggregationsInferenceConfigContainer inference_config: MlInferenceConfigCreateContainer
input: MlTrainedModelConfigInput input: MlTrainedModelConfigInput
license_level?: string license_level?: string
metadata?: MlTrainedModelConfigMetadata metadata?: MlTrainedModelConfigMetadata
@ -12178,6 +12322,22 @@ export interface MlValidationLoss {
loss_type: string loss_type: string
} }
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string
classification_labels: string[]
results_field?: string
multi_label?: boolean
labels?: string[]
}
export interface MlZeroShotClassificationInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
multi_label?: boolean
labels: string[]
}
export interface MlCloseJobRequest extends RequestBase { export interface MlCloseJobRequest extends RequestBase {
job_id: Id job_id: Id
allow_no_match?: boolean allow_no_match?: boolean
@ -12590,42 +12750,43 @@ export interface MlGetJobsResponse {
} }
export interface MlGetMemoryStatsJvmStats { export interface MlGetMemoryStatsJvmStats {
heap_max: ByteSize heap_max?: ByteSize
heap_max_in_bytes: integer heap_max_in_bytes: integer
java_inference: ByteSize java_inference?: ByteSize
java_inference_in_bytes: integer java_inference_in_bytes: integer
java_inference_max: ByteSize java_inference_max?: ByteSize
java_inference_max_in_bytes: integer java_inference_max_in_bytes: integer
} }
export interface MlGetMemoryStatsMemMlStats { export interface MlGetMemoryStatsMemMlStats {
anomaly_detectors: ByteSize anomaly_detectors?: ByteSize
anomaly_detectors_in_bytes: integer anomaly_detectors_in_bytes: integer
data_frame_analytics: ByteSize data_frame_analytics?: ByteSize
data_frame_analytics_in_bytes: integer data_frame_analytics_in_bytes: integer
max: ByteSize max?: ByteSize
max_in_bytes: integer max_in_bytes: integer
native_code_overhead: ByteSize native_code_overhead?: ByteSize
native_code_overhead_in_bytes: integer native_code_overhead_in_bytes: integer
native_inference: ByteSize native_inference?: ByteSize
native_inference_in_bytes: integer native_inference_in_bytes: integer
} }
export interface MlGetMemoryStatsMemStats { export interface MlGetMemoryStatsMemStats {
adjusted_total: ByteSize adjusted_total?: ByteSize
adjusted_total_in_bytes: integer adjusted_total_in_bytes: integer
total: ByteSize total?: ByteSize
total_in_bytes: integer total_in_bytes: integer
ml: MlGetMemoryStatsMemMlStats ml: MlGetMemoryStatsMemMlStats
} }
export interface MlGetMemoryStatsMemory { export interface MlGetMemoryStatsMemory {
attributes: string[] attributes: Record<string, string>
jvm: MlGetMemoryStatsJvmStats jvm: MlGetMemoryStatsJvmStats
mem: MlGetMemoryStatsMemStats mem: MlGetMemoryStatsMemStats
name: Name name: Name
roles: string[] roles: string[]
transport_address: TransportAddress transport_address: TransportAddress
ephemeral_id: Id
} }
export interface MlGetMemoryStatsRequest extends RequestBase { export interface MlGetMemoryStatsRequest extends RequestBase {
@ -12637,7 +12798,7 @@ export interface MlGetMemoryStatsRequest extends RequestBase {
export interface MlGetMemoryStatsResponse { export interface MlGetMemoryStatsResponse {
_nodes: NodeStatistics _nodes: NodeStatistics
cluser_name: Name cluster_name: Name
nodes: Record<Id, MlGetMemoryStatsMemory> nodes: Record<Id, MlGetMemoryStatsMemory>
} }
@ -12724,6 +12885,7 @@ export interface MlInferTrainedModelDeploymentRequest extends RequestBase {
model_id: Id model_id: Id
timeout?: Time timeout?: Time
docs: Record<string, string>[] docs: Record<string, string>[]
inference_config?: MlNlpInferenceConfigUpdateContainer
} }
export interface MlInferTrainedModelDeploymentResponse { export interface MlInferTrainedModelDeploymentResponse {
@ -13036,7 +13198,7 @@ export interface MlPutTrainedModelRequest extends RequestBase {
compressed_definition?: string compressed_definition?: string
definition?: MlPutTrainedModelDefinition definition?: MlPutTrainedModelDefinition
description?: string description?: string
inference_config: AggregationsInferenceConfigContainer inference_config: MlInferenceConfigCreateContainer
input: MlPutTrainedModelInput input: MlPutTrainedModelInput
metadata?: any metadata?: any
model_type?: MlTrainedModelType model_type?: MlTrainedModelType
@ -14579,6 +14741,8 @@ export interface SecurityGlobalPrivilege {
application: SecurityApplicationGlobalUserPrivileges application: SecurityApplicationGlobalUserPrivileges
} }
export type SecurityGrantType = 'password' | 'access_token'
export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'
export interface SecurityIndicesPrivileges { export interface SecurityIndicesPrivileges {
@ -14642,6 +14806,41 @@ export interface SecurityUser {
enabled: boolean enabled: boolean
} }
export interface SecurityUserProfile {
uid: string
user: SecurityUserProfileUser
data?: Record<string, any>
labels?: Record<string, any>
enabled?: boolean
}
export interface SecurityUserProfileHitMetadata {
_primary_term: long
_seq_no: SequenceNumber
}
export interface SecurityUserProfileUser {
email?: string | null
full_name?: Name | null
metadata: Metadata
roles: string[]
username: Username
}
export interface SecurityUserProfileWithMetadata extends SecurityUserProfile {
last_synchronized: long
_doc?: SecurityUserProfileHitMetadata
}
export interface SecurityActivateUserProfileRequest extends RequestBase {
access_token?: string
grant_type: SecurityGrantType
password?: string
username?: string
}
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
export interface SecurityAuthenticateRequest extends RequestBase { export interface SecurityAuthenticateRequest extends RequestBase {
} }
@ -14828,6 +15027,13 @@ export interface SecurityDisableUserRequest extends RequestBase {
export interface SecurityDisableUserResponse { export interface SecurityDisableUserResponse {
} }
export interface SecurityDisableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityDisableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnableUserRequest extends RequestBase { export interface SecurityEnableUserRequest extends RequestBase {
username: Username username: Username
refresh?: Refresh refresh?: Refresh
@ -14836,6 +15042,13 @@ export interface SecurityEnableUserRequest extends RequestBase {
export interface SecurityEnableUserResponse { export interface SecurityEnableUserResponse {
} }
export interface SecurityEnableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityEnableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnrollKibanaRequest extends RequestBase { export interface SecurityEnrollKibanaRequest extends RequestBase {
} }
@ -15018,6 +15231,13 @@ export interface SecurityGetUserPrivilegesResponse {
run_as: string[] run_as: string[]
} }
export interface SecurityGetUserProfileRequest extends RequestBase {
uid: string
data?: string | string[]
}
export type SecurityGetUserProfileResponse = Record<string, SecurityUserProfileWithMetadata>
export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password' export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'
export interface SecurityGrantApiKeyGrantApiKey { export interface SecurityGrantApiKeyGrantApiKey {
@ -15058,7 +15278,7 @@ export interface SecurityHasPrivilegesIndexPrivilegesCheck {
export type SecurityHasPrivilegesPrivileges = Record<string, boolean> export type SecurityHasPrivilegesPrivileges = Record<string, boolean>
export interface SecurityHasPrivilegesRequest extends RequestBase { export interface SecurityHasPrivilegesRequest extends RequestBase {
user?: Name | null user?: Name
application?: SecurityHasPrivilegesApplicationPrivilegesCheck[] application?: SecurityHasPrivilegesApplicationPrivilegesCheck[]
cluster?: SecurityClusterPrivilege[] cluster?: SecurityClusterPrivilege[]
index?: SecurityHasPrivilegesIndexPrivilegesCheck[] index?: SecurityHasPrivilegesIndexPrivilegesCheck[]
@ -15243,8 +15463,40 @@ export interface SecuritySamlServiceProviderMetadataResponse {
metadata: string metadata: string
} }
export interface SecuritySuggestUserProfilesRequest extends RequestBase {
data?: string | string[]
name?: string
size?: long
}
export interface SecuritySuggestUserProfilesResponse {
total: SecuritySuggestUserProfilesTotalUserProfiles
took: long
profiles: SecurityUserProfile[]
}
export interface SecuritySuggestUserProfilesTotalUserProfiles {
value: long
relation: RelationName
}
export interface SecurityUpdateUserProfileDataRequest extends RequestBase {
uid: string
if_seq_no?: SequenceNumber
if_primary_term?: long
refresh?: Refresh
access?: Record<string, any>
data?: Record<string, any>
}
export type SecurityUpdateUserProfileDataResponse = AcknowledgedResponseBase
export type ShutdownType = 'restart' | 'remove' | 'replace'
export interface ShutdownDeleteNodeRequest extends RequestBase { export interface ShutdownDeleteNodeRequest extends RequestBase {
node_id: NodeId node_id: NodeId
master_timeout?: TimeUnit
timeout?: TimeUnit
} }
export type ShutdownDeleteNodeResponse = AcknowledgedResponseBase export type ShutdownDeleteNodeResponse = AcknowledgedResponseBase
@ -15270,6 +15522,8 @@ export interface ShutdownGetNodePluginsStatus {
export interface ShutdownGetNodeRequest extends RequestBase { export interface ShutdownGetNodeRequest extends RequestBase {
node_id?: NodeIds node_id?: NodeIds
master_timeout?: TimeUnit
timeout?: TimeUnit
} }
export interface ShutdownGetNodeResponse { export interface ShutdownGetNodeResponse {
@ -15286,6 +15540,12 @@ export type ShutdownGetNodeShutdownType = 'remove' | 'restart'
export interface ShutdownPutNodeRequest extends RequestBase { export interface ShutdownPutNodeRequest extends RequestBase {
node_id: NodeId node_id: NodeId
master_timeout?: TimeUnit
timeout?: TimeUnit
type: ShutdownType
reason: string
allocation_delay?: string
target_node_name?: string
} }
export type ShutdownPutNodeResponse = AcknowledgedResponseBase export type ShutdownPutNodeResponse = AcknowledgedResponseBase
@ -15664,7 +15924,7 @@ export interface SnapshotRestoreRequest extends RequestBase {
ignore_unavailable?: boolean ignore_unavailable?: boolean
include_aliases?: boolean include_aliases?: boolean
include_global_state?: boolean include_global_state?: boolean
index_settings?: IndicesPutSettingsRequest index_settings?: IndicesIndexSettings
indices?: Indices indices?: Indices
partial?: boolean partial?: boolean
rename_pattern?: string rename_pattern?: string
@ -16202,7 +16462,7 @@ export interface TransformUpdateTransformRequest extends RequestBase {
source?: TransformSource source?: TransformSource
settings?: TransformSettings settings?: TransformSettings
sync?: TransformSyncContainer sync?: TransformSyncContainer
retention_policy?: TransformRetentionPolicyContainer retention_policy?: TransformRetentionPolicyContainer | null
} }
export interface TransformUpdateTransformResponse { export interface TransformUpdateTransformResponse {

View File

@ -257,7 +257,7 @@ export interface DeleteByQueryRethrottleRequest extends RequestBase {
requests_per_second?: long requests_per_second?: long
} }
export type DeleteByQueryRethrottleResponse = TasksListResponse export type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
export interface DeleteScriptRequest extends RequestBase { export interface DeleteScriptRequest extends RequestBase {
id: Id id: Id
@ -585,10 +585,21 @@ export interface MsearchMultisearchBody {
aggregations?: Record<string, AggregationsAggregationContainer> aggregations?: Record<string, AggregationsAggregationContainer>
aggs?: Record<string, AggregationsAggregationContainer> aggs?: Record<string, AggregationsAggregationContainer>
query?: QueryDslQueryContainer query?: QueryDslQueryContainer
explain?: boolean
stored_fields?: Fields
docvalue_fields?: (QueryDslFieldAndFormat | Field)[]
from?: integer from?: integer
size?: integer size?: integer
pit?: SearchPointInTimeReference sort?: Sort
_source?: SearchSourceConfig
terminate_after?: long
stats?: string[]
timeout?: string
track_scores?: boolean
track_total_hits?: SearchTrackHits track_total_hits?: SearchTrackHits
version?: boolean
seq_no_primary_term?: boolean
pit?: SearchPointInTimeReference
suggest?: SearchSuggester suggest?: SearchSuggester
} }
@ -601,6 +612,9 @@ export interface MsearchMultisearchHeader {
request_cache?: boolean request_cache?: boolean
routing?: string routing?: string
search_type?: SearchType search_type?: SearchType
ccs_minimize_roundtrips?: boolean
allow_partial_search_results?: boolean
ignore_throttled?: boolean
} }
export interface MsearchRequest extends RequestBase { export interface MsearchRequest extends RequestBase {
@ -1160,12 +1174,13 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
collate_match?: boolean collate_match?: boolean
contexts?: Record<string, SearchContext[]> contexts?: Record<string, SearchContext[]>
fields?: Record<string, any> fields?: Record<string, any>
_id: string _id?: string
_index: IndexName _index?: IndexName
_routing?: Routing _routing?: Routing
_score?: double _score?: double
_source?: TDocument _source?: TDocument
text: string text: string
score?: double
} }
export interface SearchCompletionSuggester extends SearchSuggesterBase { export interface SearchCompletionSuggester extends SearchSuggesterBase {
@ -1225,9 +1240,9 @@ export interface SearchFieldCollapse {
export interface SearchFieldSuggester { export interface SearchFieldSuggester {
completion?: SearchCompletionSuggester completion?: SearchCompletionSuggester
phrase?: SearchPhraseSuggester phrase?: SearchPhraseSuggester
term?: SearchTermSuggester
prefix?: string prefix?: string
regex?: string regex?: string
term?: SearchTermSuggester
text?: string text?: string
} }
@ -2616,6 +2631,7 @@ export interface AggregationsAggregationContainer {
geohash_grid?: AggregationsGeoHashGridAggregation geohash_grid?: AggregationsGeoHashGridAggregation
geo_line?: AggregationsGeoLineAggregation geo_line?: AggregationsGeoLineAggregation
geotile_grid?: AggregationsGeoTileGridAggregation geotile_grid?: AggregationsGeoTileGridAggregation
geohex_grid?: AggregationsGeohexGridAggregation
global?: AggregationsGlobalAggregation global?: AggregationsGlobalAggregation
histogram?: AggregationsHistogramAggregation histogram?: AggregationsHistogramAggregation
ip_range?: AggregationsIpRangeAggregation ip_range?: AggregationsIpRangeAggregation
@ -2813,14 +2829,6 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre
type?: RelationName type?: RelationName
} }
export interface AggregationsClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> { export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> {
after_key?: Record<string, any> after_key?: Record<string, any>
} }
@ -3089,6 +3097,14 @@ export interface AggregationsGeoTileGridBucketKeys extends AggregationsMultiBuck
export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys
& { [property: string]: AggregationsAggregate | GeoTile | long } & { [property: string]: AggregationsAggregate | GeoTile | long }
export interface AggregationsGeohexGridAggregation extends AggregationsBucketAggregationBase {
field: Field
precision?: integer
bounds?: GeoBounds
size?: integer
shard_size?: integer
}
export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase { export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase {
} }
export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys
@ -3186,8 +3202,8 @@ export interface AggregationsInferenceClassImportance {
} }
export interface AggregationsInferenceConfigContainer { export interface AggregationsInferenceConfigContainer {
regression?: AggregationsRegressionInferenceOptions regression?: MlRegressionInferenceOptions
classification?: AggregationsClassificationInferenceOptions classification?: MlClassificationInferenceOptions
} }
export interface AggregationsInferenceFeatureImportance { export interface AggregationsInferenceFeatureImportance {
@ -3477,11 +3493,6 @@ export interface AggregationsRateAggregation extends AggregationsFormatMetricAgg
export type AggregationsRateMode = 'sum' | 'value_count' export type AggregationsRateMode = 'sum' | 'value_count'
export interface AggregationsRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase { export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase {
} }
export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys
@ -3548,7 +3559,8 @@ export interface AggregationsSignificantTermsAggregation extends AggregationsBuc
execution_hint?: AggregationsTermsAggregationExecutionHint execution_hint?: AggregationsTermsAggregationExecutionHint
field?: Field field?: Field
gnd?: AggregationsGoogleNormalizedDistanceHeuristic gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[] include?: AggregationsTermsInclude
jlh?: EmptyObject
min_doc_count?: long min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic percentage?: AggregationsPercentageScoreHeuristic
@ -3572,6 +3584,7 @@ export interface AggregationsSignificantTextAggregation extends AggregationsBuck
filter_duplicate_text?: boolean filter_duplicate_text?: boolean
gnd?: AggregationsGoogleNormalizedDistanceHeuristic gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[] include?: string | string[]
jlh?: EmptyObject
min_doc_count?: long min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic percentage?: AggregationsPercentageScoreHeuristic
@ -4577,7 +4590,7 @@ export interface MappingDenseVectorProperty extends MappingPropertyBase {
index_options?: MappingDenseVectorIndexOptions index_options?: MappingDenseVectorIndexOptions
} }
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase { export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
doc_values?: boolean doc_values?: boolean
@ -4642,21 +4655,6 @@ export interface MappingFloatRangeProperty extends MappingRangePropertyBase {
type: 'float_range' type: 'float_range'
} }
export interface MappingGenericProperty extends MappingDocValuesPropertyBase {
analyzer: string
boost: double
fielddata: IndicesStringFielddata
ignore_malformed: boolean
index: boolean
index_options: MappingIndexOptions
norms: boolean
null_value: string
position_increment_gap: integer
search_analyzer: string
term_vector: MappingTermVectorOption
type: string
}
export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw' export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'
export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase { export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
@ -4792,7 +4790,6 @@ export type MappingProperty = MappingFlattenedProperty | MappingJoinProperty | M
export interface MappingPropertyBase { export interface MappingPropertyBase {
local_metadata?: Metadata local_metadata?: Metadata
meta?: Record<string, string> meta?: Record<string, string>
name?: PropertyName
properties?: Record<PropertyName, MappingProperty> properties?: Record<PropertyName, MappingProperty>
ignore_above?: integer ignore_above?: integer
dynamic?: MappingDynamicMapping dynamic?: MappingDynamicMapping
@ -5001,7 +4998,7 @@ export interface QueryDslConstantScoreQuery extends QueryDslQueryBase {
export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode }
export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> { export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> {
} }
@ -5019,7 +5016,7 @@ export interface QueryDslDateRangeQuery extends QueryDslRangeQueryBase {
export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction
export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase { export interface QueryDslDecayFunctionBase {
multi_value_mode?: QueryDslMultiValueMode multi_value_mode?: QueryDslMultiValueMode
} }
@ -5062,7 +5059,7 @@ export interface QueryDslFieldLookup {
export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal' export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'
export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslFieldValueFactorScoreFunction {
field: Field field: Field
factor?: double factor?: double
missing?: double missing?: double
@ -5113,7 +5110,7 @@ export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys
export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode }
export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> { export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> {
} }
@ -5379,7 +5376,7 @@ export interface QueryDslNumberRangeQuery extends QueryDslRangeQueryBase {
export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase { export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase {
} }
export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode | QueryDslQueryContainer | double } & { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode }
export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR' export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'
@ -5509,7 +5506,7 @@ export interface QueryDslQueryStringQuery extends QueryDslQueryBase {
type?: QueryDslTextQueryType type?: QueryDslTextQueryType
} }
export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslRandomScoreFunction {
field?: Field field?: Field
seed?: long | string seed?: long | string
} }
@ -5557,16 +5554,11 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
value: string value: string
} }
export interface QueryDslScoreFunctionBase {
filter?: QueryDslQueryContainer
weight?: double
}
export interface QueryDslScriptQuery extends QueryDslQueryBase { export interface QueryDslScriptQuery extends QueryDslQueryBase {
script: Script script: Script
} }
export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase { export interface QueryDslScriptScoreFunction {
script: Script script: Script
} }
@ -5755,8 +5747,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
wait_for_completion_timeout?: Time wait_for_completion_timeout?: Time
} }
export interface AsyncSearchGetResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> { export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
}
export interface AsyncSearchStatusRequest extends RequestBase { export interface AsyncSearchStatusRequest extends RequestBase {
id: Id id: Id
@ -5853,8 +5844,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
} }
} }
export interface AsyncSearchSubmitResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> { export type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>
}
export interface AutoscalingAutoscalingPolicy { export interface AutoscalingAutoscalingPolicy {
roles: string[] roles: string[]
@ -5997,6 +5987,22 @@ export interface CatAllocationRequest extends CatCatRequestBase {
export type CatAllocationResponse = CatAllocationAllocationRecord[] export type CatAllocationResponse = CatAllocationAllocationRecord[]
export interface CatComponentTemplatesComponentTemplate {
name: string
version: string
alias_count: string
mapping_count: string
settings_count: string
metadata_count: string
included_in: string
}
export interface CatComponentTemplatesRequest extends CatCatRequestBase {
name?: string
}
export type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
export interface CatCountCountRecord { export interface CatCountCountRecord {
epoch?: EpochMillis epoch?: EpochMillis
t?: EpochMillis t?: EpochMillis
@ -8755,8 +8761,7 @@ export interface EqlGetRequest extends RequestBase {
wait_for_completion_timeout?: Time wait_for_completion_timeout?: Time
} }
export interface EqlGetResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> { export type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
}
export interface EqlGetStatusRequest extends RequestBase { export interface EqlGetStatusRequest extends RequestBase {
id: Id id: Id
@ -8798,8 +8803,7 @@ export interface EqlSearchRequest extends RequestBase {
} }
} }
export interface EqlSearchResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> { export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
}
export type EqlSearchResultPosition = 'tail' | 'head' export type EqlSearchResultPosition = 'tail' | 'head'
@ -9268,7 +9272,7 @@ export interface IndicesFielddataFrequencyFilter {
min_segment_size: integer min_segment_size: integer
} }
export type IndicesIndexCheckOnStartup = boolean | 'false' | 'checksum' | 'true' export type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum'
export interface IndicesIndexRouting { export interface IndicesIndexRouting {
allocation?: IndicesIndexRoutingAllocation allocation?: IndicesIndexRoutingAllocation
@ -9454,6 +9458,7 @@ export interface IndicesMappingLimitSettings {
nested_objects?: IndicesMappingLimitSettingsNestedObjects nested_objects?: IndicesMappingLimitSettingsNestedObjects
field_name_length?: IndicesMappingLimitSettingsFieldNameLength field_name_length?: IndicesMappingLimitSettingsFieldNameLength
dimension_fields?: IndicesMappingLimitSettingsDimensionFields dimension_fields?: IndicesMappingLimitSettingsDimensionFields
ignore_malformed?: boolean
} }
export interface IndicesMappingLimitSettingsDepth { export interface IndicesMappingLimitSettingsDepth {
@ -9611,13 +9616,7 @@ export interface IndicesStorage {
allow_mmap?: boolean allow_mmap?: boolean
} }
export type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs' export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesStringFielddata {
format: IndicesStringFielddataFormat
}
export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled'
export interface IndicesTemplateMapping { export interface IndicesTemplateMapping {
aliases: Record<IndexName, IndicesAlias> aliases: Record<IndexName, IndicesAlias>
@ -9635,7 +9634,7 @@ export interface IndicesTranslog {
retention?: IndicesTranslogRetention retention?: IndicesTranslogRetention
} }
export type IndicesTranslogDurability = 'request' | 'async' export type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'
export interface IndicesTranslogRetention { export interface IndicesTranslogRetention {
size?: ByteSize size?: ByteSize
@ -9805,7 +9804,7 @@ export interface IndicesCreateRequest extends RequestBase {
export interface IndicesCreateResponse { export interface IndicesCreateResponse {
index: IndexName index: IndexName
shards_acknowledged: boolean shards_acknowledged: boolean
acknowledged?: boolean acknowledged: boolean
} }
export interface IndicesCreateDataStreamRequest extends RequestBase { export interface IndicesCreateDataStreamRequest extends RequestBase {
@ -10131,6 +10130,25 @@ export interface IndicesMigrateToDataStreamRequest extends RequestBase {
export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase
export interface IndicesModifyDataStreamAction {
add_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
remove_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
}
export interface IndicesModifyDataStreamIndexAndDataStreamAction {
index: IndexName
data_stream: DataStreamName
}
export interface IndicesModifyDataStreamRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
actions: IndicesModifyDataStreamAction[]
}
}
export type IndicesModifyDataStreamResponse = AcknowledgedResponseBase
export interface IndicesOpenRequest extends RequestBase { export interface IndicesOpenRequest extends RequestBase {
index: Indices index: Indices
allow_no_indices?: boolean allow_no_indices?: boolean
@ -10984,10 +11002,20 @@ export interface IngestGsubProcessor extends IngestProcessorBase {
export interface IngestInferenceConfig { export interface IngestInferenceConfig {
regression?: IngestInferenceConfigRegression regression?: IngestInferenceConfigRegression
classification?: IngestInferenceConfigClassification
}
export interface IngestInferenceConfigClassification {
num_top_classes?: integer
num_top_feature_importance_values?: integer
results_field?: Field
top_classes_results_field?: Field
prediction_field_type?: string
} }
export interface IngestInferenceConfigRegression { export interface IngestInferenceConfigRegression {
results_field: string results_field?: Field
num_top_feature_importance_values?: integer
} }
export interface IngestInferenceProcessor extends IngestProcessorBase { export interface IngestInferenceProcessor extends IngestProcessorBase {
@ -11614,6 +11642,14 @@ export interface MlChunkingConfig {
export type MlChunkingMode = 'auto' | 'manual' | 'off' export type MlChunkingMode = 'auto' | 'manual' | 'off'
export interface MlClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte' export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'
export type MlCustomSettings = any export type MlCustomSettings = any
@ -12004,6 +12040,18 @@ export interface MlDiscoveryNode {
export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over' export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'
export interface MlFillMaskInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlFillMaskInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlFilter { export interface MlFilter {
description?: string description?: string
filter_id: Id filter_id: Id
@ -12044,6 +12092,17 @@ export interface MlHyperparameters {
export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance'
export interface MlInferenceConfigCreateContainer {
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
}
export interface MlInfluence { export interface MlInfluence {
influencer_field_name: string influencer_field_name: string
influencer_field_values: string[] influencer_field_values: string[]
@ -12203,6 +12262,47 @@ export interface MlModelSnapshot {
timestamp: long timestamp: long
} }
export interface MlNerInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlNerInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlNlpBertTokenizationConfig {
do_lower_case?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpInferenceConfigUpdateContainer {
text_classification?: MlTextClassificationInferenceUpdateOptions
zero_shot_classification?: MlZeroShotClassificationInferenceUpdateOptions
fill_mask?: MlFillMaskInferenceUpdateOptions
ner?: MlNerInferenceUpdateOptions
pass_through?: MlPassThroughInferenceUpdateOptions
text_embedding?: MlTextEmbeddingInferenceUpdateOptions
}
export interface MlNlpRobertaTokenizationConfig {
add_prefix_space?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpTokenizationUpdateOptions {
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlOutlierDetectionParameters { export interface MlOutlierDetectionParameters {
compute_feature_influence?: boolean compute_feature_influence?: boolean
feature_influence_threshold?: double feature_influence_threshold?: double
@ -12231,6 +12331,16 @@ export interface MlPage {
size?: integer size?: integer
} }
export interface MlPassThroughInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlPassThroughInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlPerPartitionCategorization { export interface MlPerPartitionCategorization {
enabled?: boolean enabled?: boolean
stop_on_warn?: boolean stop_on_warn?: boolean
@ -12238,6 +12348,11 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = string | double export type MlPredictedValue = string | double
export interface MlRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping' export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'
export type MlRuleAction = 'skip_result' | 'skip_model_update' export type MlRuleAction = 'skip_result' | 'skip_model_update'
@ -12253,11 +12368,43 @@ export interface MlRunningStateSearchInterval {
start_ms: long start_ms: long
} }
export interface MlTextClassificationInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlTextClassificationInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
classification_labels?: string[]
}
export interface MlTextEmbeddingInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlTextEmbeddingInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlTimingStats { export interface MlTimingStats {
elapsed_time: integer elapsed_time: integer
iteration_time?: integer iteration_time?: integer
} }
export interface MlTokenizationConfigContainer {
bert?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
export interface MlTopClassEntry { export interface MlTopClassEntry {
class_name: string class_name: string
class_probability: double class_probability: double
@ -12310,7 +12457,7 @@ export interface MlTrainedModelConfig {
description?: string description?: string
estimated_heap_memory_usage_bytes?: integer estimated_heap_memory_usage_bytes?: integer
estimated_operations?: integer estimated_operations?: integer
inference_config: AggregationsInferenceConfigContainer inference_config: MlInferenceConfigCreateContainer
input: MlTrainedModelConfigInput input: MlTrainedModelConfigInput
license_level?: string license_level?: string
metadata?: MlTrainedModelConfigMetadata metadata?: MlTrainedModelConfigMetadata
@ -12411,6 +12558,22 @@ export interface MlValidationLoss {
loss_type: string loss_type: string
} }
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string
classification_labels: string[]
results_field?: string
multi_label?: boolean
labels?: string[]
}
export interface MlZeroShotClassificationInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
multi_label?: boolean
labels: string[]
}
export interface MlCloseJobRequest extends RequestBase { export interface MlCloseJobRequest extends RequestBase {
job_id: Id job_id: Id
allow_no_match?: boolean allow_no_match?: boolean
@ -12876,42 +13039,43 @@ export interface MlGetJobsResponse {
} }
export interface MlGetMemoryStatsJvmStats { export interface MlGetMemoryStatsJvmStats {
heap_max: ByteSize heap_max?: ByteSize
heap_max_in_bytes: integer heap_max_in_bytes: integer
java_inference: ByteSize java_inference?: ByteSize
java_inference_in_bytes: integer java_inference_in_bytes: integer
java_inference_max: ByteSize java_inference_max?: ByteSize
java_inference_max_in_bytes: integer java_inference_max_in_bytes: integer
} }
export interface MlGetMemoryStatsMemMlStats { export interface MlGetMemoryStatsMemMlStats {
anomaly_detectors: ByteSize anomaly_detectors?: ByteSize
anomaly_detectors_in_bytes: integer anomaly_detectors_in_bytes: integer
data_frame_analytics: ByteSize data_frame_analytics?: ByteSize
data_frame_analytics_in_bytes: integer data_frame_analytics_in_bytes: integer
max: ByteSize max?: ByteSize
max_in_bytes: integer max_in_bytes: integer
native_code_overhead: ByteSize native_code_overhead?: ByteSize
native_code_overhead_in_bytes: integer native_code_overhead_in_bytes: integer
native_inference: ByteSize native_inference?: ByteSize
native_inference_in_bytes: integer native_inference_in_bytes: integer
} }
export interface MlGetMemoryStatsMemStats { export interface MlGetMemoryStatsMemStats {
adjusted_total: ByteSize adjusted_total?: ByteSize
adjusted_total_in_bytes: integer adjusted_total_in_bytes: integer
total: ByteSize total?: ByteSize
total_in_bytes: integer total_in_bytes: integer
ml: MlGetMemoryStatsMemMlStats ml: MlGetMemoryStatsMemMlStats
} }
export interface MlGetMemoryStatsMemory { export interface MlGetMemoryStatsMemory {
attributes: string[] attributes: Record<string, string>
jvm: MlGetMemoryStatsJvmStats jvm: MlGetMemoryStatsJvmStats
mem: MlGetMemoryStatsMemStats mem: MlGetMemoryStatsMemStats
name: Name name: Name
roles: string[] roles: string[]
transport_address: TransportAddress transport_address: TransportAddress
ephemeral_id: Id
} }
export interface MlGetMemoryStatsRequest extends RequestBase { export interface MlGetMemoryStatsRequest extends RequestBase {
@ -12923,7 +13087,7 @@ export interface MlGetMemoryStatsRequest extends RequestBase {
export interface MlGetMemoryStatsResponse { export interface MlGetMemoryStatsResponse {
_nodes: NodeStatistics _nodes: NodeStatistics
cluser_name: Name cluster_name: Name
nodes: Record<Id, MlGetMemoryStatsMemory> nodes: Record<Id, MlGetMemoryStatsMemory>
} }
@ -13038,6 +13202,7 @@ export interface MlInferTrainedModelDeploymentRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: { body?: {
docs: Record<string, string>[] docs: Record<string, string>[]
inference_config?: MlNlpInferenceConfigUpdateContainer
} }
} }
@ -13382,7 +13547,7 @@ export interface MlPutTrainedModelRequest extends RequestBase {
compressed_definition?: string compressed_definition?: string
definition?: MlPutTrainedModelDefinition definition?: MlPutTrainedModelDefinition
description?: string description?: string
inference_config: AggregationsInferenceConfigContainer inference_config: MlInferenceConfigCreateContainer
input: MlPutTrainedModelInput input: MlPutTrainedModelInput
metadata?: any metadata?: any
model_type?: MlTrainedModelType model_type?: MlTrainedModelType
@ -14981,6 +15146,8 @@ export interface SecurityGlobalPrivilege {
application: SecurityApplicationGlobalUserPrivileges application: SecurityApplicationGlobalUserPrivileges
} }
export type SecurityGrantType = 'password' | 'access_token'
export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'
export interface SecurityIndicesPrivileges { export interface SecurityIndicesPrivileges {
@ -15044,6 +15211,44 @@ export interface SecurityUser {
enabled: boolean enabled: boolean
} }
export interface SecurityUserProfile {
uid: string
user: SecurityUserProfileUser
data?: Record<string, any>
labels?: Record<string, any>
enabled?: boolean
}
export interface SecurityUserProfileHitMetadata {
_primary_term: long
_seq_no: SequenceNumber
}
export interface SecurityUserProfileUser {
email?: string | null
full_name?: Name | null
metadata: Metadata
roles: string[]
username: Username
}
export interface SecurityUserProfileWithMetadata extends SecurityUserProfile {
last_synchronized: long
_doc?: SecurityUserProfileHitMetadata
}
export interface SecurityActivateUserProfileRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
access_token?: string
grant_type: SecurityGrantType
password?: string
username?: string
}
}
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
export interface SecurityAuthenticateRequest extends RequestBase { export interface SecurityAuthenticateRequest extends RequestBase {
} }
@ -15236,6 +15441,13 @@ export interface SecurityDisableUserRequest extends RequestBase {
export interface SecurityDisableUserResponse { export interface SecurityDisableUserResponse {
} }
export interface SecurityDisableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityDisableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnableUserRequest extends RequestBase { export interface SecurityEnableUserRequest extends RequestBase {
username: Username username: Username
refresh?: Refresh refresh?: Refresh
@ -15244,6 +15456,13 @@ export interface SecurityEnableUserRequest extends RequestBase {
export interface SecurityEnableUserResponse { export interface SecurityEnableUserResponse {
} }
export interface SecurityEnableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityEnableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnrollKibanaRequest extends RequestBase { export interface SecurityEnrollKibanaRequest extends RequestBase {
} }
@ -15429,6 +15648,13 @@ export interface SecurityGetUserPrivilegesResponse {
run_as: string[] run_as: string[]
} }
export interface SecurityGetUserProfileRequest extends RequestBase {
uid: string
data?: string | string[]
}
export type SecurityGetUserProfileResponse = Record<string, SecurityUserProfileWithMetadata>
export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password' export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'
export interface SecurityGrantApiKeyGrantApiKey { export interface SecurityGrantApiKeyGrantApiKey {
@ -15472,7 +15698,7 @@ export interface SecurityHasPrivilegesIndexPrivilegesCheck {
export type SecurityHasPrivilegesPrivileges = Record<string, boolean> export type SecurityHasPrivilegesPrivileges = Record<string, boolean>
export interface SecurityHasPrivilegesRequest extends RequestBase { export interface SecurityHasPrivilegesRequest extends RequestBase {
user?: Name | null user?: Name
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */ /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: { body?: {
application?: SecurityHasPrivilegesApplicationPrivilegesCheck[] application?: SecurityHasPrivilegesApplicationPrivilegesCheck[]
@ -15695,8 +15921,46 @@ export interface SecuritySamlServiceProviderMetadataResponse {
metadata: string metadata: string
} }
export interface SecuritySuggestUserProfilesRequest extends RequestBase {
data?: string | string[]
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
name?: string
size?: long
}
}
export interface SecuritySuggestUserProfilesResponse {
total: SecuritySuggestUserProfilesTotalUserProfiles
took: long
profiles: SecurityUserProfile[]
}
export interface SecuritySuggestUserProfilesTotalUserProfiles {
value: long
relation: RelationName
}
export interface SecurityUpdateUserProfileDataRequest extends RequestBase {
uid: string
if_seq_no?: SequenceNumber
if_primary_term?: long
refresh?: Refresh
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
access?: Record<string, any>
data?: Record<string, any>
}
}
export type SecurityUpdateUserProfileDataResponse = AcknowledgedResponseBase
export type ShutdownType = 'restart' | 'remove' | 'replace'
export interface ShutdownDeleteNodeRequest extends RequestBase { export interface ShutdownDeleteNodeRequest extends RequestBase {
node_id: NodeId node_id: NodeId
master_timeout?: TimeUnit
timeout?: TimeUnit
} }
export type ShutdownDeleteNodeResponse = AcknowledgedResponseBase export type ShutdownDeleteNodeResponse = AcknowledgedResponseBase
@ -15722,6 +15986,8 @@ export interface ShutdownGetNodePluginsStatus {
export interface ShutdownGetNodeRequest extends RequestBase { export interface ShutdownGetNodeRequest extends RequestBase {
node_id?: NodeIds node_id?: NodeIds
master_timeout?: TimeUnit
timeout?: TimeUnit
} }
export interface ShutdownGetNodeResponse { export interface ShutdownGetNodeResponse {
@ -15738,6 +16004,15 @@ export type ShutdownGetNodeShutdownType = 'remove' | 'restart'
export interface ShutdownPutNodeRequest extends RequestBase { export interface ShutdownPutNodeRequest extends RequestBase {
node_id: NodeId node_id: NodeId
master_timeout?: TimeUnit
timeout?: TimeUnit
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
type: ShutdownType
reason: string
allocation_delay?: string
target_node_name?: string
}
} }
export type ShutdownPutNodeResponse = AcknowledgedResponseBase export type ShutdownPutNodeResponse = AcknowledgedResponseBase
@ -16130,7 +16405,7 @@ export interface SnapshotRestoreRequest extends RequestBase {
ignore_unavailable?: boolean ignore_unavailable?: boolean
include_aliases?: boolean include_aliases?: boolean
include_global_state?: boolean include_global_state?: boolean
index_settings?: IndicesPutSettingsRequest index_settings?: IndicesIndexSettings
indices?: Indices indices?: Indices
partial?: boolean partial?: boolean
rename_pattern?: string rename_pattern?: string
@ -16687,7 +16962,7 @@ export interface TransformUpdateTransformRequest extends RequestBase {
source?: TransformSource source?: TransformSource
settings?: TransformSettings settings?: TransformSettings
sync?: TransformSyncContainer sync?: TransformSyncContainer
retention_policy?: TransformRetentionPolicyContainer retention_policy?: TransformRetentionPolicyContainer | null
} }
} }

View File

@ -19,6 +19,7 @@
/* eslint-disable @typescript-eslint/naming-convention */ /* eslint-disable @typescript-eslint/naming-convention */
/* eslint-disable @typescript-eslint/promise-function-async */ /* eslint-disable @typescript-eslint/promise-function-async */
/* eslint-disable @typescript-eslint/no-unnecessary-type-assertion */
import assert from 'assert' import assert from 'assert'
import { promisify } from 'util' import { promisify } from 'util'

View File

@ -43,6 +43,10 @@ const MAX_FILE_TIME = 1000 * 30
const MAX_TEST_TIME = 1000 * 3 const MAX_TEST_TIME = 1000 * 3
const freeSkips = { const freeSkips = {
// not supported yet
'/free/cluster.desired_nodes/10_basic.yml': ['*'],
'/free/health/30_feature.yml': ['*'],
'/free/health/40_useractions.yml': ['*'],
// the v8 client never sends the scroll_id in querystgring, // the v8 client never sends the scroll_id in querystgring,
// the way the test is structured causes a security exception // the way the test is structured causes a security exception
'free/scroll/10_basic.yml': ['Body params override query string'], 'free/scroll/10_basic.yml': ['Body params override query string'],
@ -63,13 +67,17 @@ const freeSkips = {
// the expected error is returning a 503, // the expected error is returning a 503,
// which triggers a retry and the node to be marked as dead // which triggers a retry and the node to be marked as dead
'search.aggregation/240_max_buckets.yml': ['*'], 'search.aggregation/240_max_buckets.yml': ['*'],
// long values and json do not play nicely together
'search.aggregation/40_range.yml': ['Min and max long range bounds'],
// the yaml runner assumes that null means "does not exists", // the yaml runner assumes that null means "does not exists",
// while null is a valid json value, so the check will fail // while null is a valid json value, so the check will fail
'search/320_disallow_queries.yml': ['Test disallow expensive queries'], 'search/320_disallow_queries.yml': ['Test disallow expensive queries'],
'free/tsdb/90_unsupported_operations.yml': ['noop update'] 'free/tsdb/90_unsupported_operations.yml': ['noop update']
} }
const platinumBlackList = { const platinumBlackList = {
'api_key/10_basic.yml': ['Test get api key'],
'api_key/20_query.yml': ['*'], 'api_key/20_query.yml': ['*'],
'api_key/11_invalidation.yml': ['Test invalidate api key by realm name'],
'analytics/histogram.yml': ['Histogram requires values in increasing order'], 'analytics/histogram.yml': ['Histogram requires values in increasing order'],
// this two test cases are broken, we should // this two test cases are broken, we should
// return on those in the future. // return on those in the future.
@ -107,6 +115,7 @@ const platinumBlackList = {
// Investigate why is failing // Investigate why is failing
'ml/inference_crud.yml': ['*'], 'ml/inference_crud.yml': ['*'],
'ml/categorization_agg.yml': ['Test categorization aggregation with poor settings'], 'ml/categorization_agg.yml': ['Test categorization aggregation with poor settings'],
'ml/filter_crud.yml': ['*'],
// investigate why this is failing // investigate why this is failing
'monitoring/bulk/10_basic.yml': ['*'], 'monitoring/bulk/10_basic.yml': ['*'],
'monitoring/bulk/20_privileges.yml': ['*'], 'monitoring/bulk/20_privileges.yml': ['*'],
@ -119,6 +128,8 @@ const platinumBlackList = {
'service_accounts/10_basic.yml': ['*'], 'service_accounts/10_basic.yml': ['*'],
// we are setting two certificates in the docker config // we are setting two certificates in the docker config
'ssl/10_basic.yml': ['*'], 'ssl/10_basic.yml': ['*'],
'token/10_basic.yml': ['*'],
'token/11_invalidation.yml': ['*'],
// very likely, the index template has not been loaded yet. // very likely, the index template has not been loaded yet.
// we should run a indices.existsTemplate, but the name of the // we should run a indices.existsTemplate, but the name of the
// template may vary during time. // template may vary during time.

View File

@ -188,6 +188,45 @@ function build (opts = {}) {
client, 'tasks.cancel', client, 'tasks.cancel',
tasks.map(id => ({ task_id: id })) tasks.map(id => ({ task_id: id }))
) )
// cleanup ml
const jobsList = await client.ml.getJobs()
const jobsIds = jobsList.jobs.map(j => j.job_id)
await helper.runInParallel(
client, 'ml.deleteJob',
jobsIds.map(j => ({ job_id: j, force: true }))
)
const dataFrame = await client.ml.getDataFrameAnalytics()
const dataFrameIds = dataFrame.data_frame_analytics.map(d => d.id)
await helper.runInParallel(
client, 'ml.deleteDataFrameAnalytics',
dataFrameIds.map(d => ({ id: d, force: true }))
)
const calendars = await client.ml.getCalendars()
const calendarsId = calendars.calendars.map(c => c.calendar_id)
await helper.runInParallel(
client, 'ml.deleteCalendar',
calendarsId.map(c => ({ calendar_id: c }))
)
const training = await client.ml.getTrainedModels()
const trainingId = training.trained_model_configs
.filter(t => t.created_by !== '_xpack')
.map(t => t.model_id)
await helper.runInParallel(
client, 'ml.deleteTrainedModel',
trainingId.map(t => ({ model_id: t, force: true }))
)
// cleanup transforms
const transforms = await client.transform.getTransform()
const transformsId = transforms.transforms.map(t => t.id)
await helper.runInParallel(
client, 'transform.deleteTransform',
transformsId.map(t => ({ transform_id: t, force: true }))
)
} }
const shutdownNodes = await client.shutdown.getNode() const shutdownNodes = await client.shutdown.getNode()